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>'
import requests

url = "https://{instance}.omniapp.co/api/v1/users/email-only"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.omniapp.co/api/v1/users/email-only', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/users/email-only",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{instance}.omniapp.co/api/v1/users/email-only"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/users/email-only")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/users/email-only")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
      }
    }
  ]
}
{
"error": "<response_code>",
"message": "<error_reason>"
}
{
"error": "<response_code>",
"message": "<error_reason>"
}
{
"error": "<response_code>",
"message": "<error_reason>"
}
{
"error": "<response_code>",
"message": "<error_reason>"
}

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