IRironcladapp
Entities

List All Entity IDs

Changed on

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

get/entities/ids

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/entities/ids
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.entities.readEntities

Query parameters

pageinteger

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

pageSizeinteger

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.

filterstring

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:

<ul> <li>Equals / NotEqual</li> <li>Contains</li> <li>IsEmpty / IsNotEmpty</li> <li>LessThan / LessThanOrEqual</li> <li>GreaterThan / GreaterThanOrEqual</li> <li>Date / Today / RelativeDate</li> <li>And / Or</li> </ul>
searchstring

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'name' | 'lastUpdated'

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

sortDirection'ASC' | 'DESC'

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

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

200

pageinteger
pageSizeinteger
countinteger

Example response

{
  "pageSize": 10000,
  "count": 12345,
  "list": [
    {
      "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
      "ironcladId": "CONTRACT-123"
    }
  ]
}

Changes