---
title: "List all users"
method: GET
path: "/users"
tags: ["Core resources"]
---

# List all users

`GET /users`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/users`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://dashboard.sivo.com/oauth/authorize`
    - Client credentials
    - Token URL: `https://core.sivo.com/oauth/token`
- TypeScript: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer: Maximum number of results to return, from 1 to 100; defaults to 25
- `page` string: Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters
- `expand` string[]: Extra fields to include in the page; total_count counts the matching results, exactly up to 10000
- `sort` 'created_at_desc': Result order; defaults to created_at_desc

## Response `200`

Successful operation

- object: One page of a list
  - `data` object[], required
    - `given_name` string: Non-empty text string
    - `family_name` string: Non-empty text string
    - `picture` string, uri: HTTP(S) URL
    - `name` string: Non-empty text string
    - `zoneinfo` string: IANA timezone identifier
    - `locale` string: BCP 47 locale
    - `address` object: An address as described in the OpenID connect specification for address defined in Section 5.1.1. https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim
      - `region` string: State, province, prefecture, or region component. For the US and Canada, MUST be 2-letter abbreviation.
      - `country` string, required: ISO 3166-1 alpha-2 country code
      - `formatted` string: Full mailing address, formatted for display or use on a mailing label. This field MAY contain multiple lines, separated by newlines.
      - `street_address` string: Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field MAY contain multiple lines, separated by newlines.
      - `locality` string: City, town, or locality component.
      - `postal_code` string: Zip code or postal code component.
    - `email` string, email: An email address
    - `phone_number` string: E.164 phone number
    - `email_verified` boolean: A boolean value
    - `phone_number_verified` boolean: A boolean value
    - `enabled` boolean, required: A boolean value
    - `id` string, required: An object id with prefix
    - `created_at` string, date-time, required: Creation date and time
    - `created_by` string, required: ID of the user that created this object
    - `updated_at` string, date-time, required: Last update date and time
    - `updated_by` string, required: ID of the user that last updated this object
  - `has_more` boolean, required: Whether more results follow this page in the list order
  - `next_page` string, nullable, required: Token for the page after this one, or null when this is the last page
  - `previous_page` string, nullable, required: Token for the page before this one, or null when this is the first page
  - `total_count` integer: Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

## Changes

- **2026-11-03** `4bbab9699612`: 10 info
  - added the new optional `query` request parameter `expand`
  - added the new optional `query` request parameter `limit`
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `sort`
  - …6 more

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/users/get.md)

---

[API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)