List Participants

get/public/v1/participants

get/public/v1/participants

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

Response

{
  "data": [
    {
      "id": "p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
      "initials": "JD",
      "full_name": "John Doe",
      "first_name": "John",
      "middle_name": "Michael",
      "last_name": "Doe",
      "preferred_name": "Johnny",
      "dob": "1990-05-15",
      "phone": "02 9876 5432",
      "mobile": "0412 345 678",
      "email": "john.doe@example.com",
      "status": "active",
      "primary_diagnosis": "Autism Spectrum Disorder",
      "secondary_diagnosis": "Intellectual Disability",
      "pronouns": "he/him",
      "gender": "male",
      "sex": "female",
      "language": "English",
      "ethnicity": "Australian",
      "ndis_number": "412345678",
      "external_id": "external-reference-123",
      "medicare": "4123 45678 9",
      "centrelink": "1234 567 890A",
      "invoice_email": "accounts@example.com",
      "commencement_date": "2024-01-01T00:00:00+00:00",
      "exit_date": "2025-01-01T00:00:00+00:00",
      "exit_reason": "Moved interstate",
      "exit_details": "Moved interstate",
      "is_ndis_number_exempt": false,
      "preferred_contact_method": "email",
      "created_at": "2024-01-15T10:30:00+00:00",
      "checkin_period": 30,
      "tags": [
        {
          "id": "p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
          "name": "High Priority",
          "colour": "#FF0000"
        }
      ],
      "latest_checkin": {
        "type": "phone",
        "date": "2024-01-15T10:30:00+00:00"
      }
    }
  ],
  "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 participant status. Comma-separate to combine values. One of: active, archived.
Example:active
filter[phone]string
Partial match on the phone number.
Example:9876
filter[mobile]string
Partial match on the mobile number.
Example:0412
filter[contact_number]string
Partial match across both the phone and mobile numbers.
Example:0412
filter[tags]string
Filter by participant tag UUID, as returned by the Participant Tags endpoint. Comma-separate to return participants carrying any of the tags. Alias of filter[tags:any].
Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
filter[tags:any]string
Filter by participant tag UUID. Comma-separate to return participants carrying any of the tags.
Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
filter[tags:all]string
Filter by participant tag UUID. Comma-separate to return only participants carrying every one of the tags.
Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
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 ParticipantResource

dataobject[]required
▶Show 34 child attributesHide child attributes
- idstringrequired
  Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
- initialsstringrequired
  Example:JD
- full_namestringrequired
  Example:John Doe
- first_namestringrequired
  Example:John
- middle_namestring | nullrequired
  Example:Michael
- last_namestring | nullrequired
  Example:Doe
- preferred_namestring | nullrequired
  Example:Johnny
- dobstring | nullrequired
  Example:1990-05-15
- phonestring | nullrequired
  Example:02 9876 5432
- mobilestring | nullrequired
  Example:0412 345 678
- emailstring | nullrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activearchived
- primary_diagnosisstring | nullrequired
  Example:Autism Spectrum Disorder
- secondary_diagnosisstring | nullrequired
  Example:Intellectual Disability
- pronounsstring | nullrequired
  Example:he/him
- genderstring | nullrequired
  Example:male
- sexstring | nullrequired
  Example:female
- languagestring | nullrequired
  Example:English
- ethnicitystring | nullrequired
  Example:Australian
- ndis_numberstring | nullrequired
  Example:412345678
- external_idstring | nullrequired
  Example:external-reference-123
- medicarestring | nullrequired
  Example:4123 45678 9
- centrelinkstring | nullrequired
  Example:1234 567 890A
- invoice_emailstring | nullrequired
  Example:accounts@example.com
- commencement_datestring | nullrequired
  Example:2024-01-01T00:00:00+00:00
- exit_datestring | nullrequired
  Example:2025-01-01T00:00:00+00:00
- exit_reasonstring | nullrequired
  Example:Moved interstate
- exit_detailsstring | nullrequired
  Example:Moved interstate
- is_ndis_number_exemptbooleanrequired
  Example:false
- preferred_contact_methodstring | nullrequired
  Example:email
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- checkin_periodinteger | nullrequired
  Example:30
- tagsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:High Priority
  colourstring | nullrequired
  Example:#FF0000
- latest_checkinobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  typestringrequired
  Example:phone
  datestringrequired
  Example:2024-01-15T10:30:00+00:00
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