Get a User Record Type

get/public/v1/user-record-types/{userRecordType}

get/public/v1/user-record-types/{userRecordType}

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

Response

{
  "data": {
    "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Police Check",
    "expires": true,
    "requires_verification": false,
    "is_self_service": false,
    "archived_at": "2024-06-01T00:00:00+00:00",
    "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

userRecordTypestringrequired
The user record type UUID

Response

200application/json

App.PublicApi.V1.UserRecordTypes.UserRecordTypeResource

dataobjectrequired
▶Show 7 child attributesHide child attributes
- idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
- namestringrequired
  Example:Police Check
- expiresbooleanrequired
  Example:true
- requires_verificationbooleanrequired
  Example:false
- is_self_servicebooleanrequired
  Example:false
- archived_atstring | nullrequired
  Example:2024-06-01T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors