NEnex
Search

Search records

Changed on

Search across all records in the workspace. Results are grouped by object type (e.g., person, company). Partial results are returned if some search types fail.

post/v1/search

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Request body

querystring required

Search query (1-500 characters)

Example request

{
  "query": "john doe"
}

Response

Search results grouped by type

resultsobject

Results grouped by object type (e.g., 'person', 'company')

errored_search_typesstring[]

Search types that encountered errors (partial results returned)

Example response

{
  "results": {
    "person": [
      {
        "id": "1001",
        "primary_value": "John Doe",
        "matched_value": "John Doe",
        "score": 0.95,
        "entity_definition_id": "10"
      }
    ],
    "company": [
      {
        "id": "2001",
        "primary_value": "Doe Industries",
        "matched_value": "Doe Industries",
        "score": 0.72,
        "entity_definition_id": "11"
      }
    ]
  },
  "errored_search_types": []
}

Changes