# List Users

**GET /users**

Search users

A `POST` version of this endpoint is provided if a large number of filters are required.

Returns a paginated list of users


## Servers
- Production: https://connect.century.tech/api/v1 (Production)


## Authentication methods
- Api key


## Parameters


#### Query parameters
- **userId** (array[string(uuid)])
  Filter the results by user ID.

Multiple identifiers can be specified by repeating the query parameter. e.g. `userId=value1&userId=value2`

This parameter supports a maximum of 30 identifiers.
- **upn** (array[string])
  Filter the results by user UPN.

Multiple identifiers can be specified by repeating the query parameter. e.g. `upn=value1&upn=value2`

This parameter supports a maximum of 30 identifiers.
- **externalId** (array[string])
  Filter the results by external ID.

Multiple identifiers can be specified by repeating the query parameter. e.g. `externalId=value1&externalId=value2`

This parameter supports a maximum of 30 identifiers.
- **username** (array[string])
  Filter the results by username.

Multiple identifiers can be specified by repeating the query parameter. e.g. `username=value1&username=value2`

This parameter supports a maximum of 30 identifiers.
- **email** (string(email))
  Filter the results by email address.
- **name** (string)
  Filter the results by the user's name.
- **role** (string)
  Filter the results by user role.
- **limit** (integer(int32))
  Specify the pagination limit, defaults to 100
- **offset** (integer(int32))
  Specify the pagination offset, defaults to 0.

Cannot be used with `cursor`
- **cursor** (string(byte) | null)
  Provide the next or previous page cursor
- **sort** (object)
  Specify the sort order of the results.

The default sort order is `sort[field]=createdAt&sort[direction]=desc`


## Responses
### 200: List of users.

#### Body Parameters: application/json (object)
- **data** (array[object])
  
- **pagination** (object)
  Metadata for the current pagination position

### 400: Invalid request.

### 401: Invalid authentication credentials

### 403: Not authorised to access this resource


[Powered by Bump.sh](https://bump.sh)