Skip to main content
GET
/
v1
/
collections
/
{credential_id}
/
refresh
/
status
Get collection refresh status
curl --request GET \
  --url https://api.sequin.io/v1/collections/{credential_id}/refresh/status \
  --header 'Authorization: Bearer <token>'
{
  "credential_id": "5f4b3b3e-4e3e-4b3b-8e3e-4b3e4b3e4b3e",
  "last_started_at": "2024-06-31T23:24:09Z",
  "last_succeeded_at": "2024-06-31T23:25:02Z",
  "status": "succeeded",
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://sequin.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Request parameters

credential_id
string
required
ID of the credential.

Response fields

credential_id
string
ID of the credential.
last_started_at
string
The time Sequin last started the latest refresh of the credential’s collections. A datetime in ISO 8601 format.
last_succeeded_at
string
The time Sequin last successfully refreshed the credential’s collections. A datetime in ISO 8601 format.
status
string
The status of the last refresh task. One of processing, succeeded, or failed.processing indicates Sequin is currently refreshing the credential’s collections.
error
object
If the latest refresh attempt failed (i.e. state is failed), this field contains details about the error.
{
  "credential_id": "5f4b3b3e-4e3e-4b3b-8e3e-4b3e4b3e4b3e",
  "last_started_at": "2024-06-31T23:24:09Z",
  "last_succeeded_at": "2024-06-31T23:25:02Z",
  "status": "succeeded",
  "error": null
}