Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

The profiles list endpoint supports query parameters to filter results by tags, gender, and other fields. Use filters to find matching profiles for bulk operations, segmentation checks, or integration lookups.

​
Basic request

GET /api/v3/profiles
Without filters this returns all profiles, paginated. Add query parameters to narrow results.

​
Filtering by tag

curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles?filter[tags][]=vip&filter[tags][]=member" \
  -H "Authorization: Bearer ${TOKEN}"
Pass multiple filter[tags][] values to match profiles that have any of the listed tags.

​
Filtering by gender

curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles?filter[gender]=female" \
  -H "Authorization: Bearer ${TOKEN}"

​
Combining filters

Multiple filter parameters are combined with AND logic — a profile must match all supplied filters to appear in results. 
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles?filter[gender]=female&filter[tags][]=vip" \
  -H "Authorization: Bearer ${TOKEN}"

​
Pagination

The response includes a meta.pagination object: 
{
  "meta": {
    "pagination": {
      "total": 4820,
      "count": 20,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 241
    }
  }
}
Use ?page=2, ?page=3, and so on to retrieve subsequent pages. Adjust per_page (default 20, max 50) to control result size. 
curl -X GET "https://api.[tenant].getomneo.com/api/v3/profiles?filter[tags][]=vip&page=2&per_page=50" \
  -H "Authorization: Bearer ${TOKEN}"