Skip to main content
GET
/
v1
/
users
/
email-only
List email-only users
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/users/email-only \
  --header 'Authorization: Bearer <token>'
{
  "pageInfo": {
    "hasNextPage": true,
    "nextCursor": "bob@example.com",
    "pageSize": 20,
    "totalRecords": 50
  },
  "records": [
    {
      "email": "alice@example.com",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_attributes": {
        "omni_user_email": "alice@example.com",
        "omni_user_name": "alice@example.com",
        "omni_user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "omni_is_org_admin": "false",
        "omni_user_timezone": "America/New_York",
        "department": "Engineering"
      }
    },
    {
      "email": "bob@example.com",
      "user_id": "550e8400-e29b-41d4-a716-446655440001",
      "user_attributes": {
        "omni_user_email": "bob@example.com",
        "omni_user_name": "bob@example.com",
        "omni_user_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "omni_is_org_admin": "false",
        "omni_user_timezone": "Europe/London"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

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

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

email
string

Filter users by email (partial match, case-insensitive)

cursor
string

Pagination cursor from previous response

pageSize
integer
default:20

Results per page

Required range: x <= 20
sortDirection
enum<string>
default:desc

Sort order:

  • asc - Ascending order (A-Z)
  • desc - Descending order (Z-A)
Available options:
asc,
desc

Response

Paginated list of email-only users

pageInfo
object

Pagination information for paginated responses.

records
object[]