Get a Site Tag

get/public/v1/site-tags/{siteTag}

get/public/v1/site-tags/{siteTag}

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

Response

{
  "data": {
    "id": "s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c",
    "name": "Vacancy",
    "colour": "#e30425",
    "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

siteTagstringrequired
The site tag UUID

Response

200application/json

SiteTagResource

dataobjectrequired
▶Show 4 child attributesHide child attributes
- idstringrequired
  Example:s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c
- namestringrequired
  Example:Vacancy
- colourstring | nullrequired
  Example:#e30425
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found