Tags

List asset tags

GEThttps://api.arzdigital.com/v1/tags
X-API-Key headerHow credits work

Credit use: Each successful call costs 1 credit for every 100 rows it returns, rounded up. For example, 250 rows cost 3 credits.

An empty result and any error cost nothing.

Parameters

  • limitintegerQuery
    Page size.
    Default: 100Range: 1 – 1000
  • offsetintegerQuery
    Rows to skip.
    Default: 0Range: 0 – …
  • sortstringQuery
    Default: id_asc
    relevanceid_ascid_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_desc
  • searchstringQuery
  • slugstringQuery
  • namestringQuery
  • typestringQuery
    Tag type slug.

Request headers

  • X-API-KeystringRequired

    Your API key. Send it in this header on every call; it is not accepted in the URL.

  • Accept-Languagestring
    Language for translated names and descriptions, such as fa-IR. Unsupported values fall back to en-US.

Response

One page of tags.
Response fields (11)
  • statusstring
  • metaobject
    Absent count means the data service did not report how many rows it returned.
  • meta.countinteger
    Rows this call was charged for, the length of data.
  • dataarray
  • data[].slugstring
  • data[].namestring
  • data[].display_namestring | null
  • data[].typeobject | null
  • data[].type.slugstring
  • data[].type.namestring
  • data[].type.display_namestring | null

Response headers

  • X-Credits-Charged
    Credits this call cost. 0 on every non-200 response.
  • X-Credits-Remaining
    Account balance after this call, not counting what calls still in flight have set aside. Negative only for an account in debt after an adjustment.
  • X-RateLimit-Limit
    Requests per minute allowed for this key.
  • X-RateLimit-Remaining
    Requests left in the current window.
  • X-RateLimit-Reset
    Unix seconds at which the window has room again.

Errors

  • bad_requesterror_code 1001
    A parameter is missing

Errors are never charged. Errors