Search Object Records

POST 
/objects/:schemaKey/records/search

Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336

Request

Version stringrequired

API Version

Available options2023-02-21

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix; standard objects use their own key, e.g. business.email for a company’s email.

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location Id

pagenumber

Page. Optional when using cursor pagination (searchAfter)

pageLimitnumberrequired

Page Limit

querystringrequired

Pass this query parameter to search using your searchable properties. For example, if you have a custom object called “Pets” and have configured “name” as a searchable property, you can pass name:Buddy to search for pets with the name “Buddy.”

searchAfterstring[]required

Cursor for paginating through search results using the last sort value from the previous page

modestring
Search mode. assigned_to_me returns tasks assigned to the caller within the caller's accessible-list set. Requires an authenticated user context.
Available optionsassigned_to_me

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "page": 1,
  "pageLimit": 10,
  "query": "Buddy",
  "searchAfter": [
    "sx6wyHhbFdRXh302Lunr",
    "sx6wyHhbFdRXh302Lunr"
  ],
  "mode": "assigned_to_me"
}

application/json

Successful response

application/json

Schema

Schema

recordsobject[]

Records matching the search query

totalnumberrequired

Total Number of records

aggregationsobject

Aggregation results

Example (auto)

{
  "records": [
    {
      "id": "661c06b4ffde146bdb469442",
      "owner": [
        "sx6wyHhbFdRXh302Lunr"
      ],
      "followers": [],
      "properties": {
        "name": "Buddy"
      },
      "createdAt": "2025-01-02T09:35:39.032Z",
      "updatedAt": "2025-01-02T09:35:39.032Z",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "objectId": "6d6f6e676f5f6576656e7473",
      "objectKey": "custom_objects.pet",
      "createdBy": {
        "channel": "WEB_USER",
        "createdAt": "2025-01-02T09:35:39.032Z",
        "source": "PUBLIC_API",
        "sourceId": "26653146-ec82-435d-8a99-84ecdb7fde13"
      },
      "lastUpdatedBy": {
        "channel": "WEB_USER",
        "createdAt": "2025-01-02T09:35:39.032Z",
        "source": "PUBLIC_API",
        "sourceId": "26653146-ec82-435d-8a99-84ecdb7fde13"
      },
      "searchAfter": [
        1738683828372,
        "67a235b49b289431bcf657f8"
      ]
    }
  ],
  "total": 20,
  "aggregations": {
    "status_count": [
      {
        "key": "active",
        "value": 10
      },
      {
        "key": "inactive",
        "value": 5
      }
    ]
  }
}