---
title: "List users"
source_url: https://dev.digicert.com/certcentral-apis/services-api/users/list-users.html
api_method: GET
api_endpoint: "/services/v2/user"
api_url: "https://www.digicert.com/services/v2/user"
---

**GET** `https://www.digicert.com/services/v2/user`

Use this endpoint to list all account users. Results can be filtered to a specific container using the `container_id` URL query string.


> **Info**
>
> Change the `ACCEPT` header to `text/csv` to return a CSV output of the results.


## Example requests and responses

**cURL**

```bash
curl -X GET \
  'https://www.digicert.com/services/v2/user' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
```

**Python**

```python
import requests

url = "https://www.digicert.com/services/v2/user"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)
```

**Go**

```go
package main

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

func main() {

    url := "https://www.digicert.com/services/v2/user"

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

    req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
    req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

**NodeJS**

```javascript
var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/user',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
```


## 200 OK

```json
{
  "users": [
    {
      "id": 125038,
      "username": "jane.doe@digicert.com",
      "account_id": <account_id>,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@digicert.com",
      "job_title": "Boss",
      "telephone": "555-555-5555",
      "status": "active",
      "container": {
        "id": 5,
        "public_id": "<public_id>",
        "name": "Company",
        "parent_id": 0,
        "template_id": 4,
        "ekey": "<ekey>",
        "has_logo": false,
        "is_active": true
      },
      "access_roles": [
        {
          "id": 1,
          "name": "Administrator"
        }
      ],
      "type": "standard",
      "has_container_assignments": false
    },
    {
      "id": 125039,
      "username": "john.smith@digicert.com",
      "account_id": <account_id>,
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@digicert.com",
      "job_title": "Employee",
      "telephone": "555-555-5555",
      "status": "active",
      "container": {
        "id": 5,
        "public_id": "<public_id>",
        "name": "Company",
        "parent_id": 0,
        "template_id": 4,
        "ekey": "<ekey>",
        "has_logo": false,
        "is_active": true
      },
      "access_roles": [
        {
          "id": 5,
          "name": "Standard User"
        }
      ],
      "type": "standard",
      "has_container_assignments": true,
      "container_assignments": [
        {
          "id": <container_id>,
          "parent_id": <parent_container_id>,
          "name": <container_name>,
          "is_active": true
      ]
    }
  ],
  "page": {
    "total": 2,
    "limit": 1000,
    "offset": 0
  }
}
```

## Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see [Services API - Filters, sorting, and pagination parameters](https://dev.digicert.com/md/certcentral-apis/services-api.md#filters-sorting-and-pagination-parameters).

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>container_id</td>
<td>optional</td>
<td>int</td>
<td>Filter results to the specified container.</td>
</tr>
<tr>
<td>access_role_id</td>
<td>optional</td>
<td>int</td>
<td>Limit results to users with a given access role.<br><strong>Possible values:</strong> See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#access-roles">Glossary – Access roles</a>.</td>
</tr>
<tr>
<td>without_container</td>
<td>optional</td>
<td>boolean</td>
<td>If true, response omits the <code>container</code> object for each returned user.<br><strong>Default:</strong> false</td>
</tr>
<tr>
<td>filters[<code>{{property_name}}</code>]</td>
<td>optional</td>
<td>string</td>
<td>Filters results by the specified property.<br>Replace <code>{{property_name}}</code> in your request with the property to use for filtering. This endpoint supports filtering by the following properties:<br><ul><li><code>filters[status]</code>: See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#user-status">Glossary – User status</a>.</li></ul></td>
</tr>
<tr>
<td>filters[search]</td>
<td>optional</td>
<td>string</td>
<td>Limits response to results where the value of the <code>username</code>, <code>first_name</code>, <code>last_name</code>, or <code>email</code> property matches or contains a specific string of characters.<br>To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) <strong>%</strong> character: <code>%25</code>. To search for values that are an exact match for a string of characters, omit the <code>%25</code> from the request.<br><strong>Examples:</strong><br><ul><li><code>filters[search]=%25gmail</code> Limits response to results where the value of a searched property contains the string <code>gmail</code>.</li><li><code>filters[search]=myname@gmail.com</code> Limits response to results where the value of a searched property is an exact match for the string <code>myname@gmail.com</code>.</li></ul></td>
</tr>
<tr>
<td>sort</td>
<td>optional</td>
<td>string</td>
<td>Sorts results by the value of one or more properties.<br>By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (<code>-</code>).<br>To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.<br>This endpoint supports sorting by the following properties:<br><ul><li><code>id</code></li><li><code>username</code></li><li><code>first_name</code></li><li><code>last_name</code></li><li><code>email</code></li><li><code>telephone</code></li><li><code>job_title</code></li><li><code>status</code></li><li><code>last_login_date</code></li><li><code>container_id</code></li></ul></td>
</tr>
<tr>
<td>offset</td>
<td>optional</td>
<td>int</td>
<td>Index of the first result to include in the response.</td>
</tr>
<tr>
<td>limit</td>
<td>optional</td>
<td>int</td>
<td>Total number of results to include in the response.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>users</td>
<td>array</td>
<td>List of all users returned by the request.</td>
</tr>
<tr>
<td>.. id</td>
<td>int</td>
<td>User ID.</td>
</tr>
<tr>
<td>.. username</td>
<td>string</td>
<td>String used to log in.</td>
</tr>
<tr>
<td>.. account_id</td>
<td>int</td>
<td>CertCentral account ID.</td>
</tr>
<tr>
<td>.. first_name</td>
<td>string</td>
<td>User first name.</td>
</tr>
<tr>
<td>.. last_name</td>
<td>string</td>
<td>User last name.</td>
</tr>
<tr>
<td>.. email</td>
<td>string</td>
<td>User email address.</td>
</tr>
<tr>
<td>.. job_title</td>
<td>string</td>
<td>User job title.</td>
</tr>
<tr>
<td>.. telephone</td>
<td>string</td>
<td>User phone number.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>User account status. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#user-status">Glossary – User status</a>.</td>
</tr>
<tr>
<td>.. container</td>
<td>object</td>
<td>Details about the primary account container. Omitted if request URL includes the query string <code>without_container=true</code>.</td>
</tr>
<tr>
<td>.. .. id</td>
<td>int</td>
<td>ID of the primary account container.</td>
</tr>
<tr>
<td>.. .. public_id</td>
<td>string</td>
<td>Public ID for the primary account container.</td>
</tr>
<tr>
<td>.. .. name</td>
<td>string</td>
<td>Name of the primary account container.</td>
</tr>
<tr>
<td>.. .. parent_id</td>
<td>int</td>
<td>Parent ID of the primary account container.</td>
</tr>
<tr>
<td>.. .. template_id</td>
<td>int</td>
<td>ID of the template the container is using.</td>
</tr>
<tr>
<td>.. .. ekey</td>
<td>string</td>
<td>Unique key used for custom branding.</td>
</tr>
<tr>
<td>.. .. has_logo</td>
<td>bool</td>
<td>Custom logo status for container.</td>
</tr>
<tr>
<td>.. .. is_active</td>
<td>bool</td>
<td>Active status of the container.</td>
</tr>
<tr>
<td>.. access_roles</td>
<td>array</td>
<td>Details about user's assigned access role.</td>
</tr>
<tr>
<td>.. .. id</td>
<td>int</td>
<td>ID of the access role. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#access-roles">Glossary – Access roles</a>.</td>
</tr>
<tr>
<td>.. .. name</td>
<td>string</td>
<td>Name of the access role. See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#access-roles">Glossary – Access roles</a>.</td>
</tr>
<tr>
<td>.. type</td>
<td>string</td>
<td>Defines the user account type.</td>
</tr>
<tr>
<td>.. has_container_assignments</td>
<td>bool</td>
<td>Container assignment status. If true returns container_assignments array.</td>
</tr>
<tr>
<td>.. container_assignments</td>
<td>array</td>
<td>Details about the user's container assignments.</td>
</tr>
<tr>
<td>.. .. id</td>
<td>int</td>
<td>ID of the assigned container.</td>
</tr>
<tr>
<td>.. .. parent_id</td>
<td>int</td>
<td>ID of the parent container.</td>
</tr>
<tr>
<td>.. .. name</td>
<td>string</td>
<td>Name of the assigned container.</td>
</tr>
<tr>
<td>.. .. is_active</td>
<td>bool</td>
<td>Status of the assigned container.</td>
</tr>
<tr>
<td><a href="https://dev.digicert.com/md/certcentral-apis/services-api/structures.md#page-details-object">page</a></td>
<td>object</td>
<td>Details about results. Modified using URL query strings.</td>
</tr>
</tbody>
</table>