Get a grant’s backfill

GET

/v1/grants/{id}/backfill

curl --request GET \
  --url https://api.inboxcnx.com/v1/grants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/backfill \
  --header 'Authorization: Bearer <token>'

Returns the grant’s running history backfill, else its latest one, so you can show its progress. done means every page of the range was listed and every missing mail handed to processing; the last message.received may follow seconds later. waitingReason says why a running backfill does not move.

Requires the write:connections scope.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The run

Media typeapplication/json

object

id

required

string format: uuid

grantId

required

string format: uuid

kind

required

string

Allowed values: history catch_up

since

required

string | null

until

required

string | null

roles

required

Array<string> | null

labels

required

Array<string> | null

status

required

string

Allowed values: running done cancelled

waitingReason

required

string | null

listed

required

integer

published

required

integer

estimatedMessages

required

integer | null

createdAt

required

string

finishedAt

required

string | null

Example

{
  "id": "7c1d9e2a-0b3f-4a5c-8d6e-2f1a0b9c8d7e",
  "grantId": "9b2f0c4e-6a1d-4f3b-8c55-0d7e2a91b3c4",
  "kind": "history",
  "since": "2026-09-20T10:00:00.000Z",
  "until": "2026-10-20T10:00:00.000Z",
  "roles": null,
  "labels": null,
  "status": "running",
  "waitingReason": null,
  "listed": 1200,
  "published": 950,
  "estimatedMessages": 2410,
  "createdAt": "2026-10-20T10:00:00.000Z",
  "finishedAt": null
}

403

The credential lacks the write:connections scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No history backfill for this grant

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}