GuidesAPI ReferenceRecipes
API Reference
Request a Demo
Start typing to search…

List All Entities

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

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

OAuth Scope required: public.entities.readEntities

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.

string

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

Entity properties can be identified using the Get All Entity Relationship Types 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

The field to sort Entities. Only one field is supported in the sort operation. Default is name.

Allowed:
string
enum

The direction the entities are sorted by in correlation with the sortField. Default is DESC.

Allowed:
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 7 months ago

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