Skip to content

Get Crm Connection Metadata

GET
/integrations/crm/connections/{connection_id}/metadata

Who connected this integration, and when.

Carries no credential - the token itself is never returned by this or any other route on this surface.

Authorizations

Parameters

Path Parameters

connection_id
required

The CRM connection to act through.

string

The CRM connection to act through.

Query Parameters

crm_type
required

The provider this connection belongs to. A mismatch is a 404.

string
Allowed values: hubspot salesforce pipedrive sugarcrm stripe zoho-crm freshworks facebook-ads linkedin-ads google-ads x-ads google-search-console

The provider this connection belongs to. A mismatch is a 404.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One CRM record, or one provider response.

Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer’s own data from them.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string