Skip to main content
POST
/
v2
/
objects
/
records
/
search
Search records
curl --request POST \
  --url https://api.attio.com/v2/objects/records/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "alan mathis",
  "objects": [
    "people",
    "deals",
    "1b31b79a-ddf9-4d57-a320-884061b2bcff"
  ],
  "request_as": {
    "type": "workspace"
  },
  "limit": 25
}
'
{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
      },
      "record_text": "Alan Mathison Turing",
      "record_image": "https://cdn.image-service.com/images/profiles/e67b8980-7dbb-46bf-95e3-266d7bceb096",
      "object_slug": "applications"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json
​
query
string
required

Query string to search for. An empty string returns a default set of results.

Maximum string length: 256
Example:

"alan mathis"

​
objects
string[]
required

Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs.

Minimum array length: 1

The object slug or UUID that you would like to filter by.

Example:
[
  "people",
  "deals",
  "1b31b79a-ddf9-4d57-a320-884061b2bcff"
]
​
request_as
object
required

Specifies the context in which to perform the search. Use 'workspace' to return all search results or specify a workspace member to limit results to what one specific person in your workspace can see.

​
limit
number
default:25

The maximum number of results to return. Defaults to 25.

Required range: 1 <= x <= 25
Example:

25

Response

Success

Success

​
data
object[]
required