Skip to main content
GET
Get connection
Returns matching connections as a list. Markifact connection ID lookup returns a list with one item. External ID lookup can return multiple connections.

Endpoint

Path Parameters

Query Parameters

Get by Markifact Connection ID

Get by External ID

Response

Notes

  • The response is always a list.
  • lookup_by=id only searches within your team.
  • lookup_by=external_id can return more than one connection if you use the same external ID for multiple connection types.
  • If no connection is found, the API returns 404.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection_id
string
required

Markifact connection ID by default, or your external ID when lookup_by is external_id.

Query Parameters

lookup_by
enum<string>
default:id

Use id for Markifact connection ID lookup, or external_id for your external ID.

Available options:
id,
external_id

Response

Matching connections returned.

id
string | null
required

Public Markifact connection ID.

type
string
required

Connection type.

is_private
boolean
required
display_name
string | null
external_id
string | null
created_at
integer<int64> | null
updated_at
integer<int64> | null