Get an Organisation Tag

get/public/v1/organisation-tags/{organisationTag}

get/public/v1/organisation-tags/{organisationTag}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/organisation-tags/{organisationTag}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "t1a2g3a4-f5a6-47b8-9c0d-1e2f3a4b5c6d",
    "name": "Allied Health",
    "colour": "#1f2e56",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

organisationTagstringrequired
The organisation tag UUID

Response

200application/json

OrganisationTagResource

dataobjectrequired
▶Show 4 child attributesHide child attributes
- idstringrequired
  Example:t1a2g3a4-f5a6-47b8-9c0d-1e2f3a4b5c6d
- namestringrequired
  Example:Allied Health
- colourstring | nullrequired
  Example:#1f2e56
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found