GuidesAPI ReferenceRecipes
API Reference
Request a Demo

List All Records

get
https://na1.ironcladapp.com/public/api/v1/records

View all records in the company, with filtering available via query parameters.

OAuth Scope required: public.records.readRecords

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 100000000
Defaults to 0

The page number used when paginating through a list of results.

int32
1 to 100
Defaults to 20

A limit of the number of results to return.

boolean
Defaults to false

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

string

Comma separated (no spaces) record types to export. Use the Retrieve Records Schema endpoint to retrieve a list of types.

string

Get records updated since (UTC)

string

Filter records using a formula. The record property ID should be enclosed in brackets [ ] and the value should be enclosed in single quotes ' '.

Record properties can be identified using the Retrieve Records Schema endpoint.

Supported formula operations include the following with documentation found here:

  • Equals / NotEqual
  • Contains
  • IsEmpty / IsNotEmpty
  • LessThan / LessThanOrEqual
  • GreaterThan / GreaterThanOrEqual
  • Date / Today / RelativeDate
  • And / Or
string
enum
Defaults to agreementDate

The field to sort Records. Only one field is supported in the sort operation.

Allowed:
string
enum
Defaults to DESC

The direction the records are sorted by in correlation with the sortField.

Allowed:
boolean
Defaults to false

When true, returns addresses as objects instead of strings.

Headers
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.

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

Updated 13 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago