Get features

Get features

get

Query parameters

PackageIdstringOptional

Filter by the package id.

EventIdstringOptional

Filter by the event id.

Typestring · enumOptional

Filter by the feature type.

Possible values:

CodestringOptional

Filter by the code.

NamestringOptional

Filter by the name.

DescriptionstringOptional

Filter by the description.

TagsstringOptional

Filter by the tags.

NotesstringOptional

Filter by the notes.

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:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

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

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "ParentBrandId",
        "eventId": "TrackingEventId",
        "type": "Function",
        "code": "Code",
        "name": "Name",
        "image": "https://www.example.com/image.jpg",
        "styles": "{\"color\": \"red\"}",
        "description": "Description",
        "tags": "Tag1, Tag2",
        "zOrder": 1,
        "status": "Active"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}