> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# List Users

GET https://api.coperniq.io/v1/users

Retrieve a list of users

Reference: https://docs.coperniq.io/api-reference/users/list-users

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Query parameters

- `email` (string, optional) — Email of the user to search for
- `id` (integer, optional) — ID of the user to search for
- `include_inactive` (boolean, optional, default: false) — Include deactivated members. Useful for resolving owner/createdBy ids on older records.

## Response

### 200

A list of users, or a single user when `id` or `email` is provided

- `Users_listUsers_Response_200`
  - list of User
  - User: User

## Errors

### 400 Bad Request Error

Invalid `include_inactive` (not `true` or `false`) or `id` (not an integer)

- `error` (string, optional)

### 404 Not Found Error

No user matches the `id` or `email` lookup. Deactivated users are only found with `include_inactive=true`.

- `error` (string, optional)

## Types

### User

- `id` (integer, required) — Unique identifier
- `firstName` (string, required) — First name
- `lastName` (string, required) — Last name
- `email` (string, required) — Email address
- `role` (UserRole, required, nullable)
- `isActive` (boolean, required) — Whether the user is an active member of your company. Always `true` unless `include_inactive=true`.
- `phone` (string, optional, nullable) — Phone number
- `seatType` (enum, optional, nullable) — The member's seat: `FIELD` (Field), `OFFICE` (Office) or `READONLY` (Viewer). `null` when no seat is set. Returned by `GET /users`.
  - Allowed values: `FIELD`, `OFFICE`, `READONLY`
- `laborHourlyRate` (double, optional, nullable) — Labor cost in dollars per hour (**Labour cost, $/hr** in Coperniq). `null` when not set. Returned by `GET /users`.

### UserRole

- `id` (integer, optional) — Role identifier
- `name` (string, optional) — Role name

## Examples

**Response**

```json
[
  {
    "id": 42,
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com"
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.coperniq.io/v1/users"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.coperniq.io/v1/users';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/users")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/users', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/users");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/users")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```