List connector agreements
Returns the agreements of the connector's source, the one written longest ago first. Items whose type you can't read are left out, so a page can be short with more to follow.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe ID of the connector.
waiting?booleanOnly the agreements waiting to be carried to the vendor (true), or only the others (false).
limit?integerThe maximum number of results to return.
1 <= value <= 20050cursor?stringThe next_cursor from the previous page. Leave it out to get the first page.
Returns a page of agreements.
application/json- response
One page of a connector's agreements.
data*array<>The agreements, the one written longest ago first.
next_cursor*|Pass as cursor for the next page; null on the last. A page can be short, or empty, with a cursor still to follow, so a walk stops on null and never on a short page.
validation_error: a query parameter is unknown or invalid, orcursoris malformed or came from another listing.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: your credential isn't the connector's own key. Management permission does not authorize connector activity.
application/json- response
An error response.
error*What went wrong.
connector_not_found: no connector has this ID.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X GET 'http://localhost:8600/connectors/string/agreements'{ "data": [ { "item_id": "01a10124-377f-7d3d-94ed-389b233f360b", "waiting": false, "record": { "remote_version": 3 }, "updated_at": "2026-10-03T10:06:20.766Z" } ], "next_cursor": null}