Get a batch

GET/v1/creative/batches/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

Response Body

`application/json`

cURL

curl -X GET "https://example.com/creative/batches/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "success": true,
  "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "string",
      "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
      "appId": "28c365d5-df94-4a54-8217-3ce51d068868",
      "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
      "nodeResults": {
        "property1": null,
        "property2": null
      },
      "error": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Path Parameters

Response Body

200application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`