IRironcladapp
Entities

List All Entities

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

OAuth Scope required: public.entities.readEntities

get/entities

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/entities
  • 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.

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. Default is name.

sortDirection'ASC' | 'DESC'

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

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": 20,
  "count": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "ironcladId": "ENTITY-1",
      "name": "Ironclad, Inc.",
      "status": "active",
      "lastUpdated": "2021-01-01T00:00:00Z",
      "namedTypeIds": [
        "43d3e321-e89b-12d3-a456-426614174000"
      ],
      "parentId": "123e4567-e89b-12d3-a456-426614174001"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.