--- title: "List service users" source_url: https://dev.digicert.com/certcentral-apis/services-api/users/list-service-users.html api_method: GET api_endpoint: "/services/v2/user/api-only" api_url: "https://www.digicert.com/services/v2/user/api-only" --- **GET** `https://www.digicert.com/services/v2/user/api-only` Use this endpoint to list all account service users. ## Example requests and responses ## cURL ```bash curl --request GET \ 'https://www.digicert.com/services/v2/user/api-only' \ -H 'Content-Type: application/json' \ -H 'X-DC-DEVKEY: {{api_key}}' ``` ## 200 OK ```bash { "users": [     {       "id": 125038,       "username": "1708859662bbfc56b3e1",       "account_id": ,       "first_name": "Service",       "last_name": "User",       "email": "jane.doe@digicert.com",       "status": "active",       "container": {         "id": 5,         "public_id": "",         "name": "Company",         "parent_id": 0,         "template_id": 4,         "ekey": "",         "has_logo": false,         "is_active": true       },       "access_roles": [         {           "id": 1,           "name": "Administrator"         }       ],       "type": "standard",       "has_container_assignments": false     },     {       "id": 125039,       "username": "1708859662bbf274d6df",       "account_id": ,       "first_name": "Service",       "last_name": "User-2",       "email": "john.smith@digicert.com",       "status": "active",       "container": {         "id": 5,         "public_id": "",         "name": "Company",         "parent_id": 0,         "template_id": 4,         "ekey": "",         "has_logo": false,         "is_active": true       },       "access_roles": [         {           "id": 1,           "name": "Administrator"         }       ],       "type": "standard",       "has_container_assignments": true,       "container_assignments": [         {           "id": ,           "parent_id": ,           "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).
Name Req/Opt Type Description
container_id optional int Filter results to the specified container.
access_role_id optional int Limit results to users with a given access role.
Possible values: See Glossary – Access roles.
without_container optional boolean If true, response omits the container object for each returned service-user.
Default: false
filters[{{property_name}}] optional string Filters results by the specified property.
Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
filters[status]: See Glossary – User status.
filters[search] optional string Limits response to results where the value of the username, first_name, last_name, or email property matches or contains a specific string of characters.
To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25. To search for values that are an exact match for a string of characters, omit the %25 from the request.
Examples:
  • filters[search]=%25gmail Limits response to results where the value of a searched property contains the string gmail.
  • filters[search]=myname@gmail.com Limits response to results where the value of a searched property is an exact match for the string myname@gmail.com.
sort optional string Sorts results by the value of one or more properties.
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 (-).
To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.
This endpoint supports sorting by the following properties:
  • id
  • username
  • first_name
  • last_name
  • email
  • status
  • containter_id
offset optional int Index of the first result to include in the response.
limit optional int Total number of results to include in the response.
## Response parameters
Name Type Description
users array List of all service users returned by the request.
.. id int Service user ID.
.. username string Unique username assigned to the service user.
.. account_id int CertCentral account ID.
.. first_name string Service.
.. last_name string User or User-#.
Service users are numbered incrementally as you add them (e.g., Service User, Service User-2, etc.).
.. email string Service user email address.
..status string User account status.
See Glossary - User status.
.. container object Details about the primary account container.
Omitted if request URL includes the query string without_container=true.
.. .. id int ID of the primary container.
.. .. public_id string Public ID for the primary container.
.. .. name string Name of the primary account container.
.. .. parent_id int Parent ID of the primary account container.
.. .. template_id int ID of the template the container is using.
.. .. ekey string Unique key used for custom branding.
.. .. has_logo boolean Custom logo status for the container.
.. .. is_active boolean Active status of the container.
.. access_roles array Details about the user's assigned access role.
.. .. id int ID of the access role.
See Glossary - Access roles.
.. .. name string Name of the access role.
See Glossary - Access roles.
.. type string Defines the user account type.
.. has_container_assignments boolean Container assignment status.
If true returns container_assignments array.
.. container_assignments array Details about the user's container assignments.
.. .. id int ID of the assigned container.
.. .. parent_id int ID of the parent container.
.. .. name string Name of the assigned container.
.. .. is_active boolean Status of the assigned container.
page object Details about results. Modified using URL query strings.