List tags

Path parameters

idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. Example: EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

The page number of tags to retrieve. Defaults to 1.

per_pageintegerOptional

The number of tags to return in a single page. Defaults to 100. Maximum of 100.

q[title_or_description_cont]stringOptional
Filters results to include tags where the title or description contains the specified string.
q[handle_in]stringOptional
Filters results to include only tags with handles that match the specified values.
q[author_id_eq]integerOptional

Filters results to include only tags created by the specified author (user ID).

q[recipe_id_eq]integerOptional
Filters results to include only tags associated with the specified recipe ID.
q[connection_id_eq]integerOptional
Filters results to include only tags associated with the specified connection ID.
q[only_assigned]booleanOptional
Filters results to include only tags assigned to an asset.
sort_by[]enumOptional
Specifies fields to sort the response by.
Allowed values:
sort_direction[]enumOptional
Specifies the sort order for the response.
Allowed values:

Response

Success reply
handlestring or null
Tag handle.
titlestring or null
Tag title.
descriptionstring or null
Tag description.
colorstring or null
Tag color.
created_atstring or null
Timestamp in ISO 8601 format when the API client was created.
updated_atstring or null
Timestamp in ISO 8601 format when the API client was updated.

Errors