Skip to main content
Search persons
curl --request POST \
  --url https://api.salesbricks.com/api/v2/persons/search \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "count": 123,
  "results": [
    {
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[email protected]",
      "role": "<string>",
      "preferred_name": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Query Parameters

​
limit
integer

Maximum number of results to return (default: 100, max: 1000)

​
offset
integer

Number of results to skip (default: 0)

Body

Input serializer for person search requests. Note: Pagination (limit/offset) is handled via query params, not POST body.

​
email
string

Search by email (case-insensitive substring match)

​
first_name
string

Search by first name (case-insensitive substring match)

​
last_name
string

Search by last name (case-insensitive substring match)

​
customer_id
string<uuid>

Filter persons by their associated customer ID

Response

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"