---
title: "Get All"
method: GET
path: "/public/api/users?filter={filter}"
tags: ["Users"]
---

# Get All

`GET /public/api/users?filter={filter}`

Get all the users.    
**Important:**    
Combination of `client_role` and `client_role_extension` defines the user's permission. A wrong combination of these two will cause a validation error, specifying an invalid permission. If `client_role_extension` is not passed (optional), `client_role` will refer to the corresponding base permission.
To filter on user roles, always pass both the `client_role` and `client_role_extension`. Example:

```json
filter={"where": { "client_role": "ROLEVIEWER","client_role_extension": "roleTitle"}}
```

## Query parameters

- `filter` string

## Headers

- `Accept` string

## Request body

- object
  - `Authorization` DefaultHeader
    - `Authorization` string, required

## Response `200`

OK

- object
  - `paging` object
    - `total` number
    - `skip` number
    - `limit` number
  - `data` object[]
    - `user_id` string, required
    - `username` string, required
    - `first_name` string, required
    - `last_name` string, required
    - `client_role` string, required
    - `client_role_extension` string
    - `email` string, required
    - `groups` string[], required
    - `language` string, required
    - `photo` string, required
    - `store_id` string, required
    - `tags` string[], required
    - `allow_local_login` boolean, required
    - `mobile_version` string
    - `desktop_version` string
    - `last_seen` string
    - `client_ids` string[]
    - `created_date` string, required
    - `updated_date` string, required
    - `terms_of_acceptance_date` string
    - `weekly_schedule` object
      - `mon_hours` object
        - `periods` object[]
          - `from` string
          - `to` string
      - `tue_hours` object
        - `periods` object[]
          - `from` string
          - `to` string
      - `wed_hours` object
        - `periods` object[]
          - `from` string, required
          - `to` string, required
      - `thu_hours` object
        - `periods` object[]
          - `from` string
          - `to` string
      - `fri_hours` object
        - `periods` object[]
          - `from` string
          - `to` string

---

[API](https://skmtc.dev/yoobic/apis/yoobic-public-api.md) · [All operations](https://skmtc.dev/yoobic/apis/yoobic-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yoobic/yoobic-public-api/revisions/593de97b4f65/schema)