List Users

Retrieve a paginated list of users with optional filtering, sorting, and field selection.

Endpoint

GET /v1/identities

Base URL: https://api-id.avnology.net

Authentication: API Key or OAuth token with admin:users:read scope

Request

Query Parameters

Parameter	Type	Required	Description
`page_size`	integer	No	Results per page (default: 25, max: 100)
`page_token`	string	No	Cursor from previous response
`filter`	string	No	Filter expression
`order_by`	string	No	Sort field: `create_time`, `update_time`, `email`, `last_login_at` (default: `create_time desc`)
`include_linked_providers`	boolean	No	Include linked social providers in response

Example Request

curl -G "https://api-id.avnology.net/v1/identities" \
  --data-urlencode 'filter=state = "active" AND organization_id = "org_7a2b3c4d"' \
  --data-urlencode 'page_size=25' \
  --data-urlencode 'order_by=create_time desc' \
  -H "Authorization: Bearer ak_live_..."

Response

Success (200 OK)

{
  "identities": [
    {
      "id": "usr_4f18acec-2712-4be7-a9af-b063b4f6deba",
      "email": "[email protected]",
      "username": "janesmith",
      "first_name": "Jane",
      "last_name": "Smith",
      "email_verified": true,
      "phone": "+14155551234",

Errors

Status	Code	Description
400	`AVNOLOGY_AUTH_902`	Invalid filter or query parameter
401	`AVNOLOGY_AUTH_005`	Invalid authentication
403	`AVNOLOGY_AUTH_100`	Insufficient permissions

Code Examples

JavaScript (fetch)

async function listUsers(apiKey, { filter, pageSize = 25, pageToken } = {}) {
  const url = new URL('https://api-id.avnology.net/v1/identities');
  url.searchParams.set('page_size', pageSize);
  if

Python (httpx)

import httpx

def list_users(api_key: str, filter: str = "", page_size: int = 25, page_token: str = "") -> dict:
    params

Go (net/http)

func listUsers(ctx context.Context, apiKey, filter string, pageSize int) (*ListIdentitiesResponse, error) {

Get User -- retrieve a single user
Create User -- create a new user
Filtering -- filter expression syntax
SDK: client.admin.listUsers({ filter, pageSize }) (TypeScript)

On this page