Get a Participant Record Type

get/public/v1/participant-record-types/{participantRecordType}

get/public/v1/participant-record-types/{participantRecordType}

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

Response

{
  "data": {
    "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Police Check",
    "expires": true,
    "requires_documents": true,
    "created_at": "2024-01-15T10:30:00+00:00",
    "required_for_participant_tags": [
      {
        "id": "p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "name": "High Priority",
        "colour": "#FF0000"
      }
    ]
  }
}

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

participantRecordTypestringrequired
The participant record type UUID

Response

200application/json

ParticipantRecordTypeResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
- namestringrequired
  Example:Police Check
- expiresbooleanrequired
  Example:true
- requires_documentsbooleanrequired
  Example:true
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- required_for_participant_tagsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:High Priority
  colourstring | nullrequired
  Example:#FF0000

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors