Skip to content

List Tags

Request

Returns all Tags for the specified Location, optionally filtered by entity type.

Response uses JSON:API format where type: "tag" is the resource type name (not to be confused with entity_type attribute).

Entity types:

  • common (0) - General tags
  • client (1) - Booking User Tags
  • record (2) - Appointment Tags
  • activity (3) - Event Tags

Use the entity query parameter to filter by type. Accepts both string aliases and numeric values.

Security
BearerPartnerUser
Path
company_idintegerrequired

Location ID

Query
entitystring

Filter by entity type (alias or numeric code)

Enum:"common""client""record""activity""0""1""2""3"
Example:entity=client
Headers
Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{company_id}/tags?entity=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Tags retrieved successfully

Bodyapplication/json
dataArray of objectsrequired
Response
{
  "data": [
    { … },
    { … }
  ]
}