List Referrals

get/public/v1/referrals

get/public/v1/referrals

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

Response

{
  "data": [
    {
      "id": "r1e2f3e4-r5a6-47l8-9b0c-1d2e3f4a5b6c",
      "reference": "REF-2024-00123",
      "details": "Client requires support coordination services",
      "status": "new",
      "participant_name": "Jane Smith",
      "source": "social_media",
      "form_submission": {
        "id": "f5a6b7c8-d9e0-41f2-a3b4-c5d6e7f8a9b0"
      },
      "created_at": "2024-01-15T10:30:00+00:00",
      "updated_at": "2024-01-16T14:00:00+00:00",
      "archived_at": "2024-06-01T00:00: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

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 ReferralResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:r1e2f3e4-r5a6-47l8-9b0c-1d2e3f4a5b6c
- referencestringrequired
  Example:REF-2024-00123
- detailsstring | nullrequired
  Example:Client requires support coordination services
- statusstringrequired
  Example:new
- participant_namestring | nullrequired
  Example:Jane Smith
- sourceenum<string> | nullrequired
  Available options:another_providerbrochure_or_flyerchild_protectioneventhealth_professionalndia_or_laconline_searchotherself_referralsocial_mediasupport_coordinatorwebsiteword_of_mouth
- form_submissionobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:f5a6b7c8-d9e0-41f2-a3b4-c5d6e7f8a9b0
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstring | nullrequired
  Example:2024-01-16T14:00:00+00:00
- archived_atstring | nullrequired
  Example:2024-06-01T00:00: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