Fetch progress and results for a batch run

GET

https://api.clay.com/public/v0

routines

run-batch

{routine_run_id}

results

Fetch progress and results for a batch run

curl --request GET \
  --url https://api.clay.com/public/v0/routines/run-batch/{routine_run_id}/results \
  --header 'clay-api-key: <api-key>'

{
  "error": {
    "details": [
      {
        "field": "<string>",
        "line_number": 123,
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "total_invalid_rows": 123
  },
  "routine_run_id": "<string>",
  "status": "<string>"
}

Authorizations

clay-api-key

string

header

required

Personal API key tied to your Clay user. Create one under Settings → Account in the Clay app.

Path Parameters

routine_run_id

string

required

Response

200

Option 1
Option 2

error

object

required

Show child attributes

routine_run_id

string

required

status

string

required

Allowed value: "validation_failed"

Fetch progress and results for a routine runReturns current status and paginated results for an asynchronous routine run.

Fetch progress and results for a batch run

curl --request GET \
  --url https://api.clay.com/public/v0/routines/run-batch/{routine_run_id}/results \
  --header 'clay-api-key: <api-key>'

{
  "error": {
    "details": [
      {
        "field": "<string>",
        "line_number": 123,
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "total_invalid_rows": 123
  },
  "routine_run_id": "<string>",
  "status": "<string>"
}