Connectors

Get a connector

Returns a connector, with when it last sent a heartbeat, its last run and any hold on it.

GET
/connectors/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the connector.

Response body

About errors

Returns the connector.

application/json
  1. response

A connector is a program outside Marfa that registers under an API key of its own, sends heartbeats and reports its runs.

id*string

Unique identifier for the connector.

key_id*string

The ID of the API key the connector registered under.

source*string

The source of that key. The connector's state document and agreements belong to this source.

name*string

The connector's name.

description*|

What the connector does; null if none was given.

registered_at*string

When the connector first registered.

updated_at*string

When the connector's name, description or read_only_types was last set.

last_heartbeat_at*|

When the connector last sent a heartbeat; null if never.

read_only_types*array<string>

The types whose items the connector holds read only, putting back any edit made in Marfa. [] if it declared none.

last_run*|

The connector's most recently reported run; null if it has reported none.

problems*

The source's current problems, by opaque key; {} if there are none.

hold_expires_at*|

When the hold on the connector lapses; null if no process holds it or its hold has lapsed.

  • validation_error: the query has a parameter this endpoint doesn't take.
application/json
  1. 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
  1. response

An error response.

error*

What went wrong.

  • connector_not_found: no connector has this ID, or it is registered under another key and yours lacks connectors.manage.
application/json
  1. 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
  1. 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
  1. 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
  1. 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
  1. 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
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/connectors/string'
About errors
{  "id": "01a10123-4825-7ff1-8fde-fb30a676e02b",  "key_id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",  "source": "crm",  "name": "crm",  "description": null,  "registered_at": "2026-10-03T10:01:55.251Z",  "updated_at": "2026-10-03T10:02:55.417Z",  "last_heartbeat_at": null,  "read_only_types": [    "acme.deal"  ],  "last_run": null,  "hold_expires_at": null,  "problems": {}}