> ## 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.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/users/list-email-only-users",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# List email-only users
> Retrieve email-only users with their user attributes, with support for cursor-based pagination and filtering
## OpenAPI
````yaml /api/openapi.yaml get /v1/users/email-only
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/v1/users/email-only:
get:
tags:
- Users
summary: List email-only users
description: >-
Retrieve email-only users with their user attributes, with support for
cursor-based pagination and filtering
operationId: listEmailOnlyUsers
parameters:
- name: email
in: query
schema:
type: string
description: Filter users by email (partial match, case-insensitive)
- name: cursor
in: query
schema:
type: string
description: Pagination cursor from previous response
- name: pageSize
in: query
schema:
type: integer
default: 20
maximum: 20
description: Results per page
- name: sortDirection
in: query
schema:
type: string
enum:
- asc
- desc
default: desc
description: |
Sort order:
- `asc` - Ascending order (A-Z)
- `desc` - Descending order (Z-A)
responses:
'200':
description: Paginated list of email-only users
content:
application/json:
schema:
type: object
properties:
pageInfo:
$ref: '#/components/schemas/PageInfo'
records:
type: array
items:
type: object
properties:
email:
type: string
format: email
description: User's email address
user_id:
type: string
format: uuid
description: User's membership ID
user_attributes:
type: object
description: >-
Key-value map of user attributes, including system
attributes like `omni_user_email`, `omni_user_name`,
`omni_user_id`, `omni_is_org_admin`, plus any custom
attributes.
additionalProperties:
type: string
example:
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
'400':
$ref: '#/components/responses/BadRequest'
'401':
description: Unauthorized - Invalid or missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- bearerAuth: []
components:
schemas:
PageInfo:
type: object
description: Pagination information for paginated responses.
properties:
hasNextPage:
type: boolean
description: Indicates if there are more records available.
nextCursor:
type: string
nullable: true
description: Cursor for the next page of results. `null` if no more results.
pageSize:
type: integer
description: Number of records per page.
totalRecords:
type: integer
description: Total number of records matching the query.
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
BadRequest:
description: Bad Request - Invalid parameters or request body
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Forbidden:
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````