Skip to main content
POST
/
clients
/
_search
Search clients
curl --request POST \
  --url https://api.gospott.com/clients/_search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filters": [
    {
      "type": "text",
      "operator": "contains",
      "path": "client.company.name",
      "value": "<string>"
    }
  ],
  "page": 0,
  "pageSize": 20
}
'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "domain": "<string>",
      "logoUrl": "<string>",
      "stage": {
        "id": "<string>",
        "order": 123,
        "name": "<string>",
        "colorHex": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "hasNextPage": true
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
filters
object[]
page
integer
default:0
Required range: x >= 0
pageSize
integer
default:20
Required range: 1 <= x <= 100

Response

Successfully searched clients

items
object[]
required
pagination
object
required