---
title: "Retrieve users"
method: GET
path: "/api/v1/users"
tags: ["Users"]
---

# Retrieve users

`GET /api/v1/users`

Required scope: `users:read` </br>Organization authorization: `supported`

## Query parameters

- `page` integer
- `perPage` integer
- `email` string, email
- `phone` string, phone
- `includeDeleted` boolean
- `fromUpdatedAt` string, date-time

## Response `200`

List of users that match the criteria

- OffsetBasedResponse32
  - `data` User[], required
    - `id` integer, required — Id of the user
    - `firstName` string, nullable — First name of the user
    - `lastName` string, nullable — Last name of the user
    - `email` string, nullable — Email of the user
    - `legalEmail` string, nullable — Legal email of the user (certified e-mail)
    - `phone` string, nullable — Phone number of the user
    - `profileImageUrl` string, nullable — URL of the profile image
    - `address` Address
      - `address1` string, required — First line of address
      - `address2` string, nullable — Second line of address
      - `address3` string, nullable — Third line of address
      - `zip` string, required — Zip-code
      - `city` string, required — City (readable)
      - `province` string, nullable — Province
      - `country` string, nullable — Country (readable)
      - `countryAreaId` integer, nullable — Country area id
    - `language` string, nullable — Preferred language of the user
    - `termsReadAt` string, date-time, nullable — Timestamp when the user read the terms
    - `taxIdentificationNumber` string, nullable — Personal tax number if set for the user
    - `vatNumber` string, nullable — VAT number which is the company tax id
    - `recipientCode` string, nullable — The recipient code used for e-invoicing
    - `createdAt` string, date-time, nullable — Timestamp when the user was created
    - `updatedAt` string, date-time, nullable — Timestamp when the user was last updated
    - `deletedAt` string, date-time, nullable — Timestamp when the user was deleted
    - `emailVerifiedAt` string, date-time, nullable — Timestamp when the email was verified
    - `phoneVerifiedAt` string, date-time, nullable — Timestamp when the phone was verified
    - `marketingEmailsAcceptedAt` string, date-time, nullable — Timestamp when the user accepted the marketing emails
    - `defaultTeamId` integer, nullable — ID of the default team for the user
    - `isGuest` boolean, nullable — Indicates whether this user is a guest (ad-hoc) user who has not yet completed registration
    - `nationalId` string, nullable — National identification number. Returned only when configured per operator
  - `meta` MontaPageMeta, required
    - `itemCount` integer, required
    - `currentPage` integer, required
    - `perPage` integer, required
    - `totalPageCount` integer, required
    - `totalItemCount` integer, required

## Other responses

- `400` — The request is invalid
- `401` — Consumer with provided credentials was not found
- `403` — Operator doesn't have access to resource
- `404` — Entity with the provided id was not found

---

[API](https://skmtc.net/monta/apis/monta-partner-api.md) · [All operations](https://skmtc.net/monta/apis/monta-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monta/monta-partner-api/revisions/517e18f11015/schema)