IRironcladapp
Entities

Retrieve an Entity

View a specific entity and its associated data.

OAuth Scope required: public.entities.readEntities

get/entities/{id}

Request

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

Path parameters

idstring required

The ID or Ironclad ID of the Entity to fetch.

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

idstring required

The unique identifier of the entity

ironcladIdstring required

The unique Ironclad identifier of the entity

namestring required

The name of the entity

statusstring required

The status of the entity

lastUpdatedstring required

The last updated date of the entity

propertiesRecordProperties required

The record properties associated with the record

namedTypeIdsstring[]

The unique identifiers of the relationship types associated with the entity

parentIdstring

The unique identifier of the parent entity

Example response

{
  "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.