Index users

get https://cdp.bookboost.io/api/v1/users

Index users.

Query Params

limit

integer

filter

json

filterGroup

string

Must be a valid JSON string.

filter[uuid]

string

validation.uuid.

filter[first_name]

string

Must not be greater than 255 characters.

filter[last_name]

string

Must not be greater than 255 characters.

filter[email]

string

Must not be greater than 255 characters.

filter[phone]

string

Must not be greater than 255 characters.

filter[anonymous]

boolean

filter[filterGroup]

boolean

filter[appId]

integer

filter[booking_reference]

string

Must not be greater than 255 characters.

filter[tags]

string

Specify this value to filter by user tags, use the character "," to specify multiple values. Must not be greater than 255 characters.

filter[created_at]

string

The created_at filter allows you to retrieve users based on their creation date. You can use this filter in three ways:

                1. Single Date Provided: When a single date is provided, the API will return users created on or after the specified date.

                    - Example: ?filter[created_at]=2024-07-11

                2. Date Range Provided: When two dates are provided, separated by a semicolon (;), the API will return users created between the two dates (inclusive).

                    - Example: ?filter[created_at]=2024-07-01;2024-07-11

                3. End Date Without Time: If the second date in the range does not include a time part, it will be treated as the start of the day (00:00:00), meaning users created on the end date itself will not be included.

                    - Example: ?filter[created_at]=2024-07-01;2024-07-11 (will not include users created on 2024-07-11)

filter[updated_at]

string

Specify this value to filter from date, or use the character ";" to specify a filter between two dates.

filter[external_references]

string

Specify this value to filter by external references, use the character "," to specify multiple values.

filter[external_reference_types]

string

You can extend external_references filter by specifying their types here, use the character "," to specify multiple values.

filter[connector_name]

string

filter[connector_user_id]

string

Response

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cdp.bookboost.io/api/v1/users \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200success