VeristageDevelopers
Distribution

Get the status of a distribution run

GET/distribution/queue/{ref}

Status of one queued run. Ownership is enforced via the run's collection (usergroup scope); a run the linked user doesn't own — or one that doesn't exist — returns 404. Requires the read scope and distribution access (dm or dv).

Authorization

apiKey
X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Path Parameters

ref*integer

The queue run ref (queueRef).

Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/distribution/queue/1"
{  "success": true,  "status": "success",  "message": "Success",  "data": {    "queueRef": 555,    "destinationRef": 7,    "status": 3,    "statusLabel": "sending",    "createdAt": "2026-07-15 10:00:00",    "counts": {      "resources": 12    }  }}
{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "This API key does not have the 'write' scope",  "error": {    "code": "INSUFFICIENT_SCOPE",    "message": "This API key does not have the 'write' scope"  }}

{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

List distribution destinations GET

Distribution destinations available to the api-key's linked user (feed targets such as ONIX/metadata drops). FTP credentials are **never** returned. Destinations are server-wide — the data model has no per-usergroup destination — so every caller with distribution access sees the same set. Requires the `read` scope and the linked user's distribution permission (`dm` or `dv`).

List recent distribution runs GET

The linked user's recent distribution runs, most recent first, scoped to their usergroup (a run is visible when the user can read the collection it distributes). Requires the `read` scope and distribution access (`dm` or `dv`).