Search user
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Body
Can be a string or an array with any and all fields you want to search on.
The type of the search. Can be Text or Number.
text
, number
The search term. For text-based search it has to be a string. For number-based search it has to be an array with two items specifying the range in which you want to search. Eg.: [5, 10] will serach form records between 5 and 10.
Only needed for text-based searches. Specifies the criteria in which to look for text.
BEGINS_WITH
, CONTAINS
, ENDS_WITH
This number specifies the certainty of the results returned. The higher the number the more accurate the return. It goes from 0 to 5. Default is 0.
Records to skip
Number of records to return
Response
Was this page helpful?