List Exports

get/public/v1/exports

A key held by an Admin lists every export in the provider, apart from complaint and form submission exports other people ran while a form's submissions are restricted from that Admin. Any other key lists only the exports its holder created.

get/public/v1/exports

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

Response

{
  "data": [
    {
      "id": "e1x2p3o4-r5t6-47i8-9d0e-1f2a3b4c5d6e",
      "name": "Participants Export",
      "status": "completed",
      "export_type": "shift-export",
      "export_reason": "Audit request",
      "failed_reason": "The export contained too many rows",
      "last_downloaded_at": "2024-02-01T09:00:00+00:00",
      "created_at": "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

sortstring
Sort the results. Prefix with '-' for descending. One of: created_at. Defaults to created_at descending.
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 ExportResource

dataobject[]required
▶Show 8 child attributesHide child attributes
- idstringrequired
  Example:e1x2p3o4-r5t6-47i8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Participants Export
- statusstringrequired
  Example:completed
- export_typestringrequired
  Example:shift-export
- export_reasonstring | nullrequired
  Example:Audit request
- failed_reasonstring | nullrequired
  Example:The export contained too many rows
- last_downloaded_atstring | nullrequired
  Example:2024-02-01T09:00:00+00:00
- created_atstringrequired
  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