List deliveries

GET /delivery/v1/deliveries

You can call the listDeliveries operation to get a list of all delivery objects associated with your account. If a delivery object has the SUCCESS status, you can retrieve the file from the specified delivery location.

Query parameters

Paginated results

When a cursor property appears in the response, it indicates that more results are available. To access the next page of results, send a follow-up request that includes the cursor query parameter, setting it equal to the cursor value from the previous response. On success, the next page of results is returned, potentially including a new cursor to continue walking the list.

You can customize the number of returned catalog items by providing a limit query parameter, which specifies the maximum number of items to return in the response.

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl --location "${API_BASE_URL}/api/delivery/v1/deliveries" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}" \
--data-urlencode "cursor=XXXXXXXXXX" \
--data-urlencode "limit=20"

Example

Request

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl --location "${API_BASE_URL}/api/delivery/v1/deliveries" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}"

Response

On success, returns a 200 status code and a JSON object containing an array of delivery objects.

{
  "deliveries": [
    {
      "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "status": "PENDING",
      "url": "https://bucket-name.s3.region.amazonaws.com/file-name",
      "itemIDs": [
        "XXXX-XXXX",
        "XXXX-XXXX"
      ],
      "deliveryLocations": [
        {
          "configID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "path": "path",
          "subpath": "subpath"
        }
      ],
      "notifications": {
        "webhook": {
          "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
      }
    }
  ],
  "cursor": "XXXXXXXXXXXX"
}