List Participant Records

get/public/v1/participant-records

get/public/v1/participant-records

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

Response

{
  "data": [
    {
      "id": "r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Police Check",
      "reference": "REF-12345",
      "status": "current",
      "signature_status": "signed",
      "issue_date": "2024-01-15T00:00:00+00:00",
      "expiry_date": "2025-01-15T00:00:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00",
      "participant": {
        "id": "p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
        "full_name": "John Doe"
      },
      "record_type": {
        "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
        "name": "Police Check"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

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

Query parameters

filter[status]string
Filter by record status. Comma-separate to combine values. One of: archived, current, expired, missing.
Example:current
filter[participant]string
Filter by participant UUID. Comma-separate to combine values.
Example:f1o2r3m4-a5b6-47c8-9d0e-1f2a3b4c5d6e
filter[signature_status]string
Filter by signature status. Comma-separate to combine values. One of: awaiting_signatures, not_required, not_sent, signed.
Example:signed
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of ParticipantRecordResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestring | nullrequired
  Example:Police Check
- referencestring | nullrequired
  Example:REF-12345
- statusstringrequired
  Example:current
- signature_statusstringrequired
  Example:signed
- issue_datestring | nullrequired
  Example:2024-01-15T00:00:00+00:00
- expiry_datestring | nullrequired
  Example:2025-01-15T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- participantobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  full_namestringrequired
  Example:John Doe
- record_typeobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
  namestringrequired
  Example:Police Check
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors