Get packages

Get packages

get

Query parameters

NamestringOptional

Filter by the name.

CodestringOptional

Filter by the code.

DescriptionstringOptional

Filter by the description.

TagsstringOptional

Filter by the tags.

IsDefaultbooleanOptional

Filter by the default package.

Statusstring · enumOptional

Filter by the status.

Possible values:

KeywordsstringOptional

Filter by the keywords.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

The sort order to sort. By default, the value is Descending.

Possible values:

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/packages HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "code": "CODE",
      "name": "NAME",
      "imageURL": "IMAGE",
      "patternAvatarURL": "https://www.example.com/pattern.jpg",
      "styles": "{\"color\": \"red\"}",
      "description": "DESCRIPTION",
      "tags": "TAGS",
      "isFree": true,
      "tier": 0,
      "zOrder": 1,
      "features": [
        {
          "title": "Feature Title",
          "unit": "Unit",
          "quantity": 10,
          "isUnlimited": false,
          "id": "sApKpllz4sAplsmzha",
          "parentBrandId": "Brand_ID",
          "eventId": "Event_ID",
          "type": "Function",
          "code": "Code",
          "name": "Feature Name",
          "image": "https://www.example.com/image.jpg",
          "styles": "{\"color\": \"red\"}",
          "description": "Feature Description",
          "tags": "#Tag1, #Tag2",
          "zOrder": 1,
          "status": "Active"
        }
      ],
      "prices": [
        {
          "id": "sApKpllz4sAplsmzha",
          "code": "Code",
          "name": "Name",
          "amount": 10,
          "currency": "USD",
          "description": "Description",
          "checkoutLink": "CheckoutLink",
          "tags": "Tags",
          "packageName": "PackageName",
          "packageId": "PackageId",
          "subscriptionName": "SubscriptionName",
          "subscriptionTypeId": "SubscriptionTypeId",
          "zOrder": 1
        }
      ],
      "isDefault": true
    }
  ],
  "errors": []
}