API GUIDE

Get a user by external id

GET/admin/v1/user/{id}No request bodyAuthentication required

ON THIS PAGE

Quickstart Request anatomy Response anatomy Rules Filters Errors Next steps

Overview

Overview The Get Users By External ID API allows you to retrieve a specific user's data.

Call the endpoint

Send a GET request to /admin/v1/user/{id} 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/user/example \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200

{
  "name": "Alex Morgan",
  "email": "[email protected]",
  "externalIds": [
    "ext-123abc"
  ],
  "permissionSets": [
    "Admin"
  ],
  "department": "Customer Success",
  "view": "Standard View",
  "workspaces": [
    "Default workspace"
  ],
  "date_created": "2025-08-22T20:43:44.888Z",
  "jobFunction": "Other"
}

Request anatomy

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

Parameters

Name	Location	Type	Required	Description
`id`	path	string	Required	An external client defined identifier for the user (set when creating the user) Example: dcb34525-2baa-4f54-8c11-9e6175ecbc74

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Returns the requested user details matching the provided ID

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

Rules

Use GET with the path /admin/v1/user/{id}.
Required inputs: id.
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
`id`	path	string	Required	An external client defined identifier for the user (set when creating the user) Example: dcb34525-2baa-4f54-8c11-9e6175ecbc74

Errors

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

Status	Meaning
`400`	Returned if the user specification in the request body 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
`404`	Request failed.
`500`	Returned if there was an issue on the server side and could not find the user.

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