Retrieve a Record

get

https://na1.ironcladapp.com/public/api/v1/records/{id}

View a specific record and its associated data.

OAuth Scope required: public.records.readRecords

Path Params

string

required

The ID or Ironclad ID of the Record.

Query Params

hydrateEntities

boolean

Defaults to false

Indicates whether to fully hydrate related entities (true) or return minimal information (false).

addressAsObject

boolean

Defaults to false

When true, returns addresses as objects instead of strings.

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400