Get account

GET 
/accounts/:account_id

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns an Account object with the given id.

Request

Path Parameters

account_id stringrequired
Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

AccountData

application/json

Schema

Schema

name stringnullablerequired
domains string[]required

Example (from schema)

{
  "name": "Waystar Royco",
  "domains": [
    "waystar-royco.com"
  ]
}

Loading...