Client Tags

List Client Tags

Lists all client tags.

GET

/client-tags

List Client Tags

curl --request GET \
  --url 'https://api.operating.app/v1/client-tags?after=%3Cstring%3E&limit=123&createdBefore=%3Cstring%3E&createdSince=%3Cstring%3E&updatedBefore=%3Cstring%3E&updatedSince=%3Cstring%3E&archived=true&archivedBefore=%3Cstring%3E&archivedAfter=%3Cstring%3E&externalId=%3Cstring%3E&categoryId=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "archivedAt": "<string>",
      "categoryId": "<string>",
      "createdAt": "<string>",
      "description": "<string>",
      "externalClientTags": [
        {
          "createdAt": "<string>",
          "externalId": "<string>",
          "externalSystemName": "<string>",
          "name": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "id": "<string>",
      "name": "<string>",
      "parentTagId": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "nextCursor": "<string>"
  }
}

Client tags can be used to categorize clients.

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

afterstringquery

For pagination. Return results after this cursor.

limitnumberquery

For pagination. Return at most this number of results.

createdBeforestringquery

Filter records by whether they were created before a certain instant in ISO8601 format in UTC.

createdSincestringquery

Filter records by whether they were created after a certain instant in ISO8601 format in UTC.

updatedBeforestringquery

Filter records by whether they were updated before a certain instant in ISO8601 format in UTC.

updatedSincestringquery

Filter records by whether they were updated after a certain instant in ISO8601 format in UTC.

archivedenum<string>query

Filter records by whether they have been archived. By default both archived and not archived records are returned.

Available options: true, false

archivedBeforestringquery

Filter records by whether they were archived before a certain instant in ISO8601 format in UTC.

archivedAfterstringquery

Filter records by whether they were archived after a certain instant in ISO8601 format in UTC.

externalIdstringquery

Filter records by external id.

categoryIdstringquery

Filter by category id

Response

Successful response

dataobject[]required

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team