List Site Records

get/public/v1/site-records

get/public/v1/site-records

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

Response

{
  "data": [
    {
      "id": "r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Fire Safety Certificate",
      "reference": "REF-12345",
      "status": "current",
      "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",
      "site": {
        "id": "s1t2e3a4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
        "name": "Main Office"
      },
      "record_type": {
        "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
        "name": "Fire Safety Certificate"
      }
    }
  ],
  "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 SiteRecordResource

dataobject[]required
▶Show 9 child attributesHide child attributes
- idstringrequired
  Example:r1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestring | nullrequired
  Example:Fire Safety Certificate
- referencestring | nullrequired
  Example:REF-12345
- statusstringrequired
  Example:current
- 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
- siteobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1t2e3a4-b5c6-47d8-9e0f-1a2b3c4d5e6f
  namestringrequired
  Example:Main Office
- record_typeobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
  namestringrequired
  Example:Fire Safety Certificate
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