For the complete documentation index, see llms.txt. This page is also available as Markdown.

Search profiles

This endpoint allows for searching profiles based on specific query parameters like first_name and is_offline, etc. It supports filtering to refine search results and utilizes pagination to handle large datasets efficiently.

Endpoint

GET /api/profiles/search/

Query Parameters:

Core Filters

id (uuid): Filters reservations by the ID.

first_name (string): Filters profiles by the first name.

last_name (string): Filters profiles by the last name.

email (string): Filters profiles by the email.

created_at (string, ISO-8601): Filters profiles by profile_details.created_at.

  • created_at.gte (string, ISO-8601): Filters by profile_details.created_at >= value.

  • created_at.gt (string, ISO-8601): Filters by profile_details.created_at > value (strictly after).

  • created_at.lte (string, ISO-8601): Filters by profile_details.created_at <= value.

  • created_at.lt (string, ISO-8601): Filters by profile_details.created_at < value (strictly before).

Sample Requests

Filtering using Custom Fields

  • custom_fields.custom_field_value.value_info.value (string): Filters profiles by the value_info's value of the custom_field_value within the custom fields.

Authorization

Requests to this endpoint require an API-KEY in the header:

Response Object

The response includes a count of total profiles found, navigation links for pagination, and an array of profile data:

For a complete description of each field in this response object, you can visit: Profiles

Last updated