---
title: "Get/provide an information about users."
method: GET
path: "/users"
tags: ["users"]
---

# Get/provide an information about users.

`GET /users`

## Request

- Base URL: `sandbox.collectly.co/api/api/partners/v1` (relative, and the document’s source URL is not known)
- URL: `sandbox.collectly.co/api/api/partners/v1/users`
- Auth: API key in header `Authorization`

Get/provide an information about users.

## Query parameters

- `page` integer
- `per_page` integer
- `sort` string

## Response `200`

OK

- User
  - `active` boolean
  - `allowed_clients` integer[], nullable
  - `company` CompanyProfile
    - `address` string, nullable
    - `allow_smart_retries` boolean
    - `allow_users_edit_pp` boolean
    - `auto_approve_rules` boolean, nullable
    - `city` string, nullable
    - `collectly_activated` boolean, nullable
    - `company_name` string, nullable
    - `country_code` string, nullable
    - `hide_access_codes` boolean, nullable
    - `hide_appointments` boolean
    - `hide_dashboard_user` boolean, nullable
    - `id` string
    - `is_2fa_enforced` boolean
    - `is_template` boolean, nullable
    - `logo_url` string, nullable
    - `salesforce_account_id` string, nullable
    - `sidebar_logout_timeout_minutes` integer, nullable
    - `state` string, nullable
    - `zip_code` string, nullable
  - `confirmed_at` unknown
  - `created_at` unknown
  - `email` string, email, required
  - `external_id` string
  - `first_name` string, required
  - `id` string
  - `last_name` string, nullable
  - `password` string, required
  - `phone` string, nullable

## Changes

- **2026-11-03** `a45575a6e4b8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/collectly/apis/partners1/changes/users/get.md)

---

[API](https://skmtc.dev/collectly/apis/partners1.md) - [All operations](https://skmtc.dev/collectly/apis/partners1/llms.txt) - [OpenAPI document](https://skmtc.dev/collectly/apis/partners1/revisions/a45575a6e4b8?raw)
