Search records

v1.0.0

The search records endpoint provides a convenient way to fuzzy search for records across one or more objects. The matching strategy employed in this endpoint follows the in-product strategy and will match names, domains, emails, phone numbers and social handles on people and companies, and labels on all other objects. Please note, results returned from this endpoint are eventually consistent. For results which are guaranteed to be up to date, please use the record query endpoint instead.

This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.

Required scopes: record_permission:read, object_configuration:read.

Input

{
  "type": "object",
  "required": [
    "objects",
    "query",
    "request_as"
  ],
  "properties": {
    "limit": {
      "type": "number",
      "description": "The maximum number of results to return. Defaults to 25."
    },
    "objects": {
      "type": "array",
      "description": "Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs.",
      "items": {
        "type": "string",
        "description": "The object slug or UUID that you would like to filter by."
      }
    },
    "query": {
      "type": "string",
      "description": "Query string to search for. An empty string returns a default set of results."
    },
    "request_as": {
      "description": "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.",
      "type": "object"
    }
  }
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}