TAtalon
Attributes

List custom attributes

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Return all the custom attributes for the account.

get/v1/attributes

Request

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

entitystring

Returned attributes will be filtered by supplied entity.

applicationIdsstring

Returned attributes will be filtered by supplied application ids

loyaltyProgramIdsstring

Returned attributes will be filtered by the specified loyalty program ids, separated by commas. You can only use this parameter when entity is LoyaltyCard.

typestring

Returned attributes will be filtered by supplied type

kind'builtin' | 'custom'

Returned attributes will be filtered by supplied kind (builtin or custom)

searchstring

Returned attributes will be filtered by searching case insensitive through Attribute name, description and type

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "accountId": 3886,
      "entity": "Event",
      "eventType": "pageViewed",
      "name": "pageViewed",
      "title": "Page view event",
      "type": "string",
      "description": "Event triggered when a customer displays a page.",
      "editable": true,
      "subscribedApplicationsIds": [
        1,
        4,
        9
      ],
      "subscribedCatalogsIds": [
        2,
        5
      ],
      "allowedSubscriptions": [
        "application",
        "catalog"
      ],
      "eventTypeId": 22
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.