> ## Documentation Index > Fetch the complete documentation index at: https://docs.slate.inc/llms.txt > Use this file to discover all available pages before exploring further. # List users > Retrieve a paginated list of users for a given owner, with optional filtering and ordering. ## OpenAPI ````yaml /api-reference/users/openapi.yaml get /v1/users openapi: 3.0.0 info: title: Users API description: >- Manage user profiles and their signature and notary seal images. Supports listing users for an owner, retrieving and updating individual profiles, and requesting upload URLs for user images. version: 1.0.0 contact: name: Slate API Support email: api-support@slate.inc url: https://slate.inc servers: - url: https://api.slate.inc/users description: Production - url: https://api.uat.slate.inc/users description: UAT (staging) security: - bearerAuth: [] paths: /v1/users: get: summary: List users description: >- Retrieve a paginated list of users for a given owner, with optional filtering and ordering. operationId: getV1Users parameters: - in: query name: fields required: false description: > Field mask restricting the response to the listed User fields (`id` is always included). Comma-separated. When omitted, the lean default fields are returned (id, name, email, title, phoneNumber, deactivatedAt). Supported values: id, name, email, title, phoneNumber, deactivatedAt, country, jurisdiction, county, commissionNumber, notaryExpirationDate, notaryExpires, getImageUrls. The special value `*` returns every field. Requesting any notary value or `getImageUrls` (including via `*`) requires the `reporting` or `manage` permission. style: form explode: false schema: type: array items: type: string enum: - '*' - id - name - email - title - phoneNumber, - deactivatedAt - country - jurisdiction - county - commissionNumber - notaryExpirationDate, - notaryExpires - getImageUrls - isNotary default: - - id - name - email - title - phoneNumber - deactivatedAt - isNotary - in: query name: limit required: false schema: type: integer default: 100 minimum: 1 description: The number of items to return per page (default 100). - in: query name: cursor required: false schema: type: string description: The cursor for fetching the next page of results. - in: query name: owner required: true schema: type: string description: The owner (client group) whose users should be returned. - in: query name: orderBy description: The field to order the results by. Defaults to `name`. schema: type: string default: name enum: - id - name - email - title - deactivatedAt - in: query name: orderDirection description: The direction to order the results by. Defaults to `asc`. schema: type: string default: asc enum: - asc - desc - in: query name: filter description: One or more fields and their values on which to filter results. style: deepObject schema: type: object properties: name: type: string email: type: string role: type: string description: >- Returns only users who hold this role (by role name) for the owner. active: type: boolean description: >- When omitted, both active and deactivated users are returned. `true` returns only active users; `false` returns only deactivated users. responses: '200': description: A paginated list of users. content: application/json: schema: type: object properties: users: type: array items: $ref: '#/components/schemas/User' pagination: $ref: '#/components/schemas/Pagination' '400': description: Invalid request parameters. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid, or insufficient credentials. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Unexpected internal error. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: User: type: object description: >- A user. List responses populate the lean fields by default and add notary fields and image URLs when requested via the `fields` mask; the detail views (GET/PUT /v1/users/{userId}) always populate notary fields and image URLs. required: - id properties: id: type: string format: uuid description: The user's unique ID. name: type: string description: The user's display name. email: type: string description: The user's email address. title: type: string description: The user's job title. phoneNumber: type: string description: The user's phone number. country: type: string jurisdiction: type: string county: type: string commissionNumber: type: string notaryExpirationDate: type: string format: date-time notaryExpires: type: boolean deactivatedAt: type: string format: date-time description: >- When the user was deactivated. Absent or null means the user is active. getImageUrls: type: array description: >- Download URLs for the user's signature and notary seal images (detail views only). items: $ref: '#/components/schemas/ImageUrl' isNotary: type: boolean description: Whether the user is a notary. uploadImageUrls: type: array deprecated: true description: >- Upload (PUT) URLs returned when an image upload was requested (detail views only). Deprecated — request upload URLs via POST /v1/users/{userId}/images and upload before saving the profile. items: $ref: '#/components/schemas/ImageUrl' Pagination: type: object properties: totalCount: type: integer description: Total number of users available. previousCursor: type: string description: >- The cursor to fetch the previous page of results (empty string if there are no more pages). nextCursor: type: string description: >- The cursor to fetch the next page of results (empty string if there are no more pages). Error: type: object required: - message properties: message: type: string description: A human-readable error message. ImageUrl: type: object required: - type - url properties: type: type: string description: The image type, either "signature" or "notary_seal". url: type: string description: >- A presigned URL. For getImageUrls it is a download (GET) URL; for uploadImageUrls it is an upload (PUT) URL. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Cognito-issued JWT access token. Send it as `Authorization: Bearer `. ````