Get a Participant Tag

get/public/v1/participant-tags/{participantTag}

get/public/v1/participant-tags/{participantTag}

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

Response

{
  "data": {
    "id": "p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "High Risk",
    "colour": "#FF0000",
    "created_at": "2026-08-12T09:30:00+10: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

participantTagstringrequired
The participant tag UUID

Response

200application/json

App.PublicApi.V1.ParticipantTags.ParticipantTagResource

dataobjectrequired
▶Show 4 child attributesHide child attributes
- idstringrequired
  Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:High Risk
- colourstring | nullrequired
  Example:#FF0000
- created_atstringrequired
  Example:2026-08-12T09:30:00+10:00

Errors

401Unauthenticated
403Authorization error
404Not found