Get Attributes

List custom attributes

GET/v1/attributes

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Attributes action (under management).
Fill in the fields below, then reference the result from later steps as {{getAttributes.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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

typestring

Returned attributes will be filtered by supplied type

kindstring

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

One ofbuiltincustom

searchstring

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

Response

Returns 200 with an object. Read it in later steps with {{getAttributes.response.data.<field>}}.

totalResultSizeinteger (int64)

dataarray<object>

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

accountIdinteger (int64)required

The ID of the account that owns this entity.

entitystringrequired

The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type.

One ofApplicationCampaignCustomerProfileCustomerSessionCartItemCouponEventGiveawayLoyaltyCardReferralStore

eventTypestring

namestringrequired

The attribute name that will be used in API requests and Talang. E.g. if `name == "region"` then you would set the region attribute by including an `attributes.region` property in your request payload.

titlestringrequired

The human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique.

typestringrequired

The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format.

One ofstringnumberbooleantime(list string)(list number)(list time)location(list location)

descriptionstringrequired

A description of this attribute.

suggestionsarray<string>required

A list of suggestions for the attribute.

hasAllowedListboolean

Whether or not this attribute has an allowed list of values associated with it.

Default false

restrictedBySuggestionsboolean

Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property).

Default false

editablebooleanrequired

Whether or not this attribute can be edited.

subscribedApplicationsIdsarray<integer (int64)>

A list of the IDs of the applications where this attribute is available.

subscribedCatalogsIdsarray<integer (int64)>

A list of the IDs of the catalogs where this attribute is available.

allowedSubscriptionsarray<string>

A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity.

eventTypeIdinteger (int64)

json

{
  "totalResultSize": 1,
  "data": [
    {
      "created": {},
      "editable": true,
      "subscribedApplicationsIds": [
        1,
        4,
        9
      ],
      "description": "Event triggered when a customer displays a page.",
      "restrictedBySuggestions": false,
      "eventType": "pageViewed",
      "title": "Page view event",
      "type": "string",
      "accountId": 3886,
      "eventTypeId": 22,
      "hasAllowedList": false,
      "allowedSubscriptions": [
        "application",
        "catalog"
      ],
      "name": "pageViewed",
      "suggestions": [
        "suggestions",
        "suggestions",
        "suggestions",
        "suggestions",
        "suggestions"
      ],
      "id": 6,
      "subscribedCatalogsIds": [
        2,
        5
      ],
      "entity": "Event"
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?