List entities

Returns paginated list of of top-level information about entities.

NOTICE: Entity Type is will be optional soon.

Because the response is paginated, the request body has a limit and offset field. At least one must be filled.

  • limit indicates how many objects the request returns (the page maximum is 50)
  • offset indicates the offset for pagination. An offset value of 1 starts with the environment's first record. The offset is relative to the number of pages (not the total count of objects).
  • case_id is a filter. Only entities with the associated case ID will be shown.
  • alert_id is a filter. Only entities with the associated alert ID will be shown.

The total_count field contains the total number of entities where the response_count field contains the number of entities included in the response.

Click Try It! to start a request and see the response here!