Skip to content

List assignments

GET
/connector/v1/assignments

Read this connector’s outstanding assignments for reconciliation, ordered by creation time and identity, oldest first. This is a live inventory, not a snapshot. An active process session is not required. Retrieving work never authorizes another backend submission or execution attempt.

limit
integer format: int32
default: 20 >= 1 <= 100

Maximum summaries per page; specifications are fetched separately.

cursor
string
<= 2048 characters

Opaque continuation scoped to this connector’s outstanding inventory.

Bounded summaries of running assignments and terminal assignments awaiting delivery settlement. Revocations, stale heartbeats, and released sessions do not hide existing work.

Media typeapplication/json
object
items
required
Array<object>

Bounded identity and progress only; scientific inputs are available in detail.

object
assignment_id
required
string format: uuid
attempt_id
required
string format: uuid
created_at
required
string format: date-time
journal_id
required
string format: uuid
phase
One of:
null
run_id
required
string format: uuid
state
required

Public execution state. Delegated preparation and collection are running.

string
Allowed values: queued running succeeded failed cancelled
next_cursor

Opaque continuation over a live inventory, oldest assignments first.

string | null
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Invalid, unknown, duplicate, or incompatible pagination parameters. Code invalid_pagination.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Active connector credential required, rechecked while holding the connector lock.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

WWW-Authenticate
string

Bearer

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

413: the request body exceeds the configured size limit.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Assignment inspection is temporarily unavailable.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

An HTTP request failed; inspect the stable error code and request ID.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.