List All Entity IDs

get

https://ironcladapp.com/public/api/v1/entities/ids

Returns only the identifiers of the entities you can access, without entity bodies or properties. Use this to determine which entities are visible to your credentials without paying the cost of a full entity listing.

Filtering, sorting, and pagination behave the same as List All Entities, and the identifiers returned are the same ones that endpoint would return for the same parameters. Because each result contains only identifiers, pageSize may be set as high as 10000.

OAuth Scope required: public.entities.readEntities

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

0 to 100000000

Defaults to 0

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

pageSize

int32

1 to 10000

Defaults to 10000

A limit of the number of results to return. The identifier-only endpoints return a small, fixed amount of data per result, so they support a much larger page size than the corresponding list endpoints.

filter

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

length ≤ 1000

Free-text search across all entity properties, matching the in-app search. Combined with filter and any other parameters using logical AND. Maximum 1000 characters.

sortField

string

enum

Defaults to name

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

Allowed:

sortDirection

string

enum

Defaults to DESC

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

Allowed:

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

Loading…

Response

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

application/json

200200

400400

401401

403403

404404