List Contacts for a Participant

get/public/v1/participants/{participant}/contacts

get/public/v1/participants/{participant}/contacts

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

Response

{
  "data": [
    {
      "contact": {
        "id": "c1o2n3t4-a5c6-47t8-9b0c-1d2e3f4a5b6c",
        "full_name": "Jane Doe",
        "first_name": "John",
        "last_name": "Doe",
        "dob": "1985-03-22",
        "email": "jane.doe@example.com",
        "phone": "02 9876 5432",
        "mobile": "0412 345 678",
        "gender": "male",
        "occupation": "Support Coordinator",
        "description": "Primary point of contact for scheduling",
        "archived_at": "2025-01-01T00:00:00+00:00",
        "preferred_contact_method": "mobile",
        "created_at": "2024-01-15T10:30:00+00:00"
      },
      "relationship": "Mother",
      "starred": true,
      "consent": true,
      "details": "Only contact during business hours",
      "visible_to_support_workers": false
    }
  ],
  "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.

Path parameters

participantstringrequired
The participant UUID

Query parameters

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 ParticipantContactResource

dataobject[]required
▶Show 6 child attributesHide child attributes
- contactobjectrequired
  ▶Show 14 child attributesHide child attributes
  idstringrequired
  Example:c1o2n3t4-a5c6-47t8-9b0c-1d2e3f4a5b6c
  full_namestringrequired
  Example:Jane Doe
  first_namestring | nullrequired
  Example:John
  last_namestring | nullrequired
  Example:Doe
  dobstring | nullrequired
  Example:1985-03-22
  emailstring | nullrequired
  Example:jane.doe@example.com
  phonestring | nullrequired
  Example:02 9876 5432
  mobilestring | nullrequired
  Example:0412 345 678
  genderstring | nullrequired
  Example:male
  occupationstring | nullrequired
  Example:Support Coordinator
  descriptionstring | nullrequired
  Example:Primary point of contact for scheduling
  archived_atstring | nullrequired
  Example:2025-01-01T00:00:00+00:00
  preferred_contact_methodstring | nullrequired
  Example:mobile
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- relationshipstring | nullrequired
  Example:Mother
- starredbooleanrequired
  Example:true
- consentboolean | nullrequired
  Example:true
- detailsstring | nullrequired
  Example:Only contact during business hours
- visible_to_support_workersbooleanrequired
  Example:false
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
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors