Skip to main content
POST
/
v1
/
user
/
search
Search users
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: 'John Doe',
    email: 'john@example.com',
    phone: '+14155551234',
    ssn: '123-45-6789',
    cursor: '<string>',
    limit: 25,
    sort: 'created_at',
    order: 'desc'
  })
};

fetch('https://api.getpalm.com/v1/user/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "object": "list",
  "has_more": true,
  "next_cursor": "crs_7g8h9i0j1k2l3m4n",
  "data": [
    "<array>"
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Body

application/json
​
display_name
string

Filter by display name (partial match, case-insensitive)

Example:

"John Doe"

​
email
string

Filter by email address (exact match). Value is hashed for secure lookup.

Example:

"john@example.com"

​
phone
string

Filter by phone number (exact match). Value is hashed for secure lookup.

Example:

"+14155551234"

​
ssn
string

Filter by SSN (exact match). Value is hashed for secure lookup.

Example:

"123-45-6789"

​
cursor
string

Pagination cursor from previous response

​
limit
number
default:25

Maximum number of results to return (1-100)

​
sort
enum<string>
default:created_at

Field to sort by

Available options:
created_at,
name,
risk_level,
last_verified
​
order
enum<string>
default:desc

Sort order direction

Available options:
asc,
desc

Response

Search results returned successfully

​
object
enum<string>
required

Object type identifier, always "list"

Available options:
list
Example:

"list"

​
has_more
boolean
required

Whether there are more results available

Example:

true

​
next_cursor
object
required

Cursor to use for fetching the next page of results. Only present when has_more is true.

Example:

"crs_7g8h9i0j1k2l3m4n"

​
data
array[]
required

Array of resources for the current page