---
title: "Retrieve users"
url: "https://earlyaccess.developers.bynder.com/apis/users-1/versions/81ec58a1-c748-4616-b383-861ec1c98a2d/paths/api-v4-users/get"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/users-1/versions/81ec58a1-c748-4616-b383-861ec1c98a2d.md

# Retrieve users

`GET` `/api/v4/users/`

## Query parameters

- `includeInActive` (boolean, optional) - Whether to include inactive users in the list of results.
- `limit` (integer, optional) - Maximum results to return. If limit is not provided, all results are returned.
- `page` (integer, optional) - What page of results to return.

## Responses

- `200` - Successful response

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Users
  version: 1.0.0
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/v4/users/:
    get:
      parameters:
        - description: Whether to include inactive users in the list of results.
          in: query
          name: includeInActive
          required: false
          schema:
            default: false
            type: boolean
        - description: Maximum results to return. If limit is not provided, all results
            are returned.
          in: query
          name: limit
          required: false
          schema:
            default: 100
            type: integer
        - description: What page of results to return.
          in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  properties:
                    active:
                      type: integer
                    country:
                      type: string
                    email:
                      type: string
                    email2:
                      type: string
                    employeeNumber:
                      type: string
                    groups:
                      items:
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                        type: object
                      type: array
                    id:
                      type: string
                    isSSOOnly:
                      type: boolean
                    name:
                      type: string
                    profileId:
                      type: string
                    salesrepId:
                      type: string
                    timeZone:
                      type: string
                    username:
                      type: string
                    website:
                      type: string
                  type: object
                type: array
          description: Successful response
          headers:
            X-Pagination-Limit:
              description: Limit of records per page.
              schema:
                type: integer
            X-Pagination-Page:
              description: Current page number.
              schema:
                type: integer
            X-Pagination-TotalPages:
              description: Total number of pages.
              schema:
                type: integer
            X-Pagination-TotalRecords:
              description: Total number of records.
              schema:
                type: integer
      security:
        - permanentToken:
            - USERMANAGEMENT
        - OAuth2:
            - USERMANAGEMENT
      summary: Retrieve users
      tags:
        - Users
security:
  - permanentToken:
      - USERMANAGEMENT
  - OAuth2:
      - USERMANAGEMENT
components:
  securitySchemes:
    permanentToken:
      in: header
      name: Authorization
      type: apiKey
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          scopes:
            USERMANAGEMENT: Grants permission to manage users
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
        clientCredentials:
          scopes:
            USERMANAGEMENT: Grants permission to manage users
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
      type: oauth2
```