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": "[email protected]",
    "pageSize": 20,
    "totalRecords": 50
  },
  "records": [
    {
      "email": "[email protected]",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "user_attributes": {
        "omni_user_email": "[email protected]",
        "omni_user_name": "[email protected]",
        "omni_user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "omni_is_org_admin": "false",
        "omni_user_timezone": "America/New_York",
        "department": "Engineering"
      }
    },
    {
      "email": "[email protected]",
      "user_id": "550e8400-e29b-41d4-a716-446655440001",
      "user_attributes": {
        "omni_user_email": "[email protected]",
        "omni_user_name": "[email protected]",
        "omni_user_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "omni_is_org_admin": "false",
        "omni_user_timezone": "Europe/London"
      }
    }
  ]
}

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
records
object[]