List Documents for a Contact

get/public/v1/contacts/{contact}/documents

get/public/v1/contacts/{contact}/documents

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

Response

{
  "data": [
    {
      "id": "d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "name": "Service Agreement",
      "file_extension": "pdf",
      "created_at": "2024-01-15T10:30:00+00:00",
      "categories": [
        {
          "id": "c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9",
          "name": "Assessments"
        }
      ]
    }
  ],
  "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

contactstringrequired
The contact UUID

Query parameters

sortstring
Sort the documents. Prefix with '-' for descending. One of: created_at.
Example:-created_at
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 DocumentResource

dataobject[]required
▶Show 5 child attributesHide child attributes
- idstringrequired
  Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Service Agreement
- file_extensionstringrequired
  Example:pdf
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- categoriesobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
  namestringrequired
  Example:Assessments
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