API GUIDE

Get list of users

GET/admin/v1/usersNo request bodyAuthentication required

ON THIS PAGE

Quickstart Request anatomy Response anatomy Rules Filters Errors Next steps

Overview

Overview This endpoint allows you to retrieve users with pagination (max pageSize 100) and filters for departments, views, permissionSets, and workspaces.

Call the endpoint

Send a GET request to /admin/v1/users with the required authentication and parameters.

Supply endpoint parameters

Review the parameter table to see which path, query, or header values the endpoint accepts.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST

curl --request GET \
  --url https://uapi.demandbase.com/admin/v1/users \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200

{
  "totalCount": 2,
  "data": [
    {
      "name": "Alex Morgan",
      "email": "[email protected]",
      "externalIds": [
        "ext-12345"
      ],
      "permissionSets": [
        "General User",
        "Admin"
      ],
      "department": "Engineering",
      "view": "Standard View",
      "workspaces": [
        "Default workspace"
      ],
      "date_created": "2024-01-15T12:34:56Z",
      "jobFunction": "Other"
    },
    {
      "name": "Jordan Lee",
      "email": "[email protected]",
      "externalIds": [],
      "permissionSets": [
        "General User"
      ],
      "department": "Marketing",
      "view": "Standard View",
      "workspaces": [
        "Default workspace"
      ],
      "date_created": "2023-11-02T08:15:30Z",
      "jobFunction": "Marketing"
    }
  ]
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

Name	Location	Type	Required	Description
`departments`	query	string	Optional	comma separated list of departments Example: Marketing,Sales
`views`	query	string	Optional	comma separated list of views Example: Standard View,Marketing View
`permissionSets`	query	string	Optional	comma separated list of permission sets Example: General User,Admin
`workspaces`	query	string	Optional	comma separated list of workspaces (if enabled) Example: global workspace
`pageNo`	query	integer	Optional	Default: 1 Example: 5
`pageSize`	query	integer	Optional	Default: 25 Example: 25 Max: 100

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Returns a paginated list of users.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

Use GET with the path /admin/v1/users.
Required inputs: No parameters are marked required in the published schema..
Authenticate every request with a valid Demandbase access token.
This endpoint does not require a JSON request body.

Filters

The published schema exposes the following endpoint inputs. Use the location column to place each value correctly.

Name	Location	Type	Required	Description
`departments`	query	string	Optional	comma separated list of departments Example: Marketing,Sales
`views`	query	string	Optional	comma separated list of views Example: Standard View,Marketing View
`permissionSets`	query	string	Optional	comma separated list of permission sets Example: General User,Admin
`workspaces`	query	string	Optional	comma separated list of workspaces (if enabled) Example: global workspace
`pageNo`	query	integer	Optional	Default: 1 Example: 5
`pageSize`	query	integer	Optional	Default: 25 Example: 25 Max: 100

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

Status	Meaning
`400`	Returned if the user specification in the request does not match the required format.
`401`	Returned if the authentication credentials are missing or invalid
`403`	Returned if the authenticated user lacks the "User Management" permission
`500`	Returned if there was an issue on the server side and could not get list of users.

Next steps

Technical specification

View the full endpoint specification

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to user