Sign in
Objects

Find objects

Use a set of filter conditions to find objects in your workspace. Returns a list of object IDs that you can use to look up object attributes, or to create or modify objects.

The list is paged if you have a large number of objects. You can set the limit for the number of objects returned, and use the start to page through the results. It's possible that you'll see duplicate entries across pages. If you want to export objects or relationships, you may want to use the export feature in our UI to return complete results.

post/v1/objects

Query parameters

startstring

The token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.

limitinteger

The maximum number of results you want to retrieve per page.

Request body

object_type_idstring required

The type of object you want to search in. Object type IDs are integers passed as strings.

Example request

{
  "object_type_id": "1",
  "filter": {
    "and": [
      {
        "object_attribute": {
          "field": "cancelled",
          "operator": "eq",
          "value": true,
          "type_id": 1
        }
      }
    ]
  }
}

Response

Returns arrays of identifiers and ids.

idsstring[]

A list of object IDs matching the object_type_id and filter in the request. Items are the same as the object_id values under identifiers, but this array may be easier to search/sort through if you have a large number of objects and don't need to to use the cio_object_id.

nextstring

Indicates the next page of results. Add ?start=<next_value> to the request to get the next page of results.

Example response

{
  "identifiers": [
    {
      "cio_object_id": "ob020101",
      "object_id": "ae3000"
    }
  ],
  "ids": [
    "ae3000"
  ]
}

Changes