Demandbase

Demandbase User Management API

The User Management API from Demandbase — 3 operation(s) for user management.

GitHub OpenAPI

Operations 5

POST /admin/v1/user Create new user
PUT /admin/v1/user Update users #
GET /admin/v1/users Get list of users
GET /admin/v1/user/{id} Get a user by external id
DELETE /admin/v1/user/{id} Delete user using external user id #

Documentation

📖
Documentation
https://developer.demandbase.com/docs/b2b-overview
📖
APIReference
https://developer.demandbase.com/reference/companysearch_1
📖
GettingStarted
https://developer.demandbase.com/docs/b2b-make-your-first-request
📖
Authentication
https://developer.demandbase.com/docs/b2b-authentication
📖
RateLimits
https://developer.demandbase.com/docs/b2b-rate-limits
📖
BestPractices
https://developer.demandbase.com/docs/b2b-best-practices
📖
Documentation
https://developer.demandbase.com/docs/export-overview
📖
APIReference
https://developer.demandbase.com/reference/createexportjob
📖
GettingStarted
https://developer.demandbase.com/docs/make-your-first-request
📖
Authentication
https://developer.demandbase.com/docs/authentication
📖
RateLimits
https://developer.demandbase.com/docs/rate-limits
📖
Documentation
https://developer.demandbase.com/docs/import-overview
📖
APIReference
https://developer.demandbase.com/reference/post_job
📖
GettingStarted
https://developer.demandbase.com/docs/make-your-first-request-1
📖
Authentication
https://developer.demandbase.com/docs/authentication-1
📖
RateLimits
https://developer.demandbase.com/docs/rate-limits-1
📖
Documentation
https://developer.demandbase.com/reference/company-intent
📖
APIReference
https://developer.demandbase.com/reference/companyintent-1
📖
Documentation
https://developer.demandbase.com/docs/user-admin-overview
📖
APIReference
https://developer.demandbase.com/reference/post_admin-v1-user
📖
Authentication
https://developer.demandbase.com/docs/authentication-3
📖
Documentation
https://developer.demandbase.com/docs/credit-usage-overview
📖
APIReference
https://developer.demandbase.com/reference/getcreditusagedetails
📖
Authentication
https://developer.demandbase.com/docs/authentication-2
📖
Documentation
https://developer.demandbase.com/docs/custom-sources-overview
📖
APIReference
https://developer.demandbase.com/reference/get_integration-v1-custom-sources
📖
Documentation
https://developer.demandbase.com/docs/authenticating-with-the-apis
📖
APIReference
https://developer.demandbase.com/reference/generate_access_token
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/demandbase/refs/heads/main/authentication/demandbase-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/demandbase/refs/heads/main/openapi/demandbase-user-management-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/demandbase/refs/heads/main/asyncapi/demandbase-webhooks.yml
🔗
FAQ
https://developer.demandbase.com/docs/faq
🔗
ErrorCatalog
https://developer.demandbase.com/docs/handling-errors
🔗
Filters
https://developer.demandbase.com/docs/how-to-use-filters
🔗
ChangeLog
https://developer.demandbase.com/changelog/new-beta-company-intent-api

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/demandbase-user-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

demandbase-user-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2.0'
  title: Admin User Management API
  description: "<div style=\"background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;\">\n<h3>Overview</h3>\n  Use the <strong>Admin API</strong> to manage users, permissions, and other administrative functions across your Demandbase account.\n</div>\n\n<div style=\"background:#FFFFFF; border-left:4px solid #007acc; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;\">\n\n> **Rate Limiting** \n> <br>Admin API endpoints are restricted to 90 requests per minute per HTTP method (e.g., GET, POST, PUT, DELETE).\n> <br>If the limit is exceeded, the API will respond with an HTTP 429 Too Many Requests error.\n> <br><br><strong>Recommendations to Stay Within Limits:</strong><ul>\n> <li>Distribute traffic across time intervals rather than sending bursts</li>\n> <li>Batch operations where possible to reduce request volume</li>\n> <li>Implement exponential backoff when retrying 429 errors</li>\n> <li>Monitor your usage trends and adjust polling or sync frequency accordingly</li>\n> <li>Use idempotent design where applicable to safely retry failed requests</li>\n> </ul>\n\n**Example Use**\n```text\ncurl --location 'https://uapi.demandbase.com/admin/v1/users' \\\n--header 'Authorization: Bearer <your auth token>'\n```\n**Response**\n```json\n{\n    \"totalCount\": 1,\n    \"data\": [\n        {\n            \"name\": \"Test User\",\n            \"email\": \"TestUser@demandbase.com\",\n            \"externalIds\": [],\n            \"permissionSets\": [\n                \"Demandbase One for Sales\",\n                \"General User\"\n            ],\n            \"department\": \"Ad Operations\",\n            \"view\": \"Standard View\",\n            \"workspaces\": [\n                \"Default workspace\"\n            ],\n            \"date_created\": \"2025-03-11T05:38:17.007Z\",\n            \"jobFunction\": \"Other\"\n        }\n    ]\n}\n```\n</div>"
servers:
- url: https://uapi.demandbase.com
security:
- token: []
tags:
- name: User Management
paths:
  /admin/v1/user:
    post:
      tags:
      - User Management
      summary: Create new user
      description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        <h3>Overview</h3><br>

        Creates a new <strong>user</strong> within your Demandbase account.

        </div>'
      requestBody:
        description: '<div style="background:#FFFFFF; border-left:4px solid #4444FF; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

          <h3>Request Body</h3><br>

          The Create User API request body defines key attributes for a user, including identification, permissions, and default interface (view) preferences.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> User successfully created<br>

            <strong>Return:</strong> JSON object representing the new user

            </div>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewUserResponse'
              example:
                externalId: ext-123abc
                email: user@example.com
                fullName: Alex Morgan
                permissionSets:
                - Admin
                department: Customer Success
                view: Standard View
                workspaces:
                - Default workspace
                jobFunction: Other
        '400':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Invalid request body or missing required fields<br>

            <strong>Return:</strong> JSON error object

            </div>'
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  details:
                    type: array
                    items:
                      type: string
                  requestId:
                    type: string
                x-examples:
                  Example 1:
                    code: 400
                    details:
                    - 'department: test is invalid'
                    - 'permissionSet: test is invalid'
                    requestId: cf89308c-7cb9-437a-ac56-2f9804199a3b
        '401':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Authentication failed or missing credentials<br>

            <strong>Return:</strong> JSON error status object

            </div>'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                x-examples:
                  Example 1:
                    status: Authentication Failed - Unauthorized.
        '403':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Returned if the authenticated credentials lacks the "User Management" permission<br>

            <strong>Return:</strong> JSON error object

            </div>'
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  details:
                    type: string
                  requestId:
                    type: string
                x-examples:
                  Example 1:
                    code: 403
                    details: You are not authorized to perform this action.
                    requestId: 2159a31a-2b41-4672-9e36-596137771cc9
        '500':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Returned if there was an issue on the server side and the user could not be created.<br>

            </div>'
      security:
      - token: []
      servers:
      - url: https://uapi.demandbase.com
    put:
      tags:
      - User Management
      summary: Update users
      description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        <h3>Overview</h3><br>

        Updates an existing <strong>user</strong> within your Demandbase account.

        </div>'
      operationId: put-users
      requestBody:
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

          <h3>Request Body</h3><br>

          The Update User API request body defines key attributes for a user, including identification, permissions, and default interface (view) preferences.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> User successfully updated<br>

            <strong>Return:</strong> JSON object representing the updated user

            </div>

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewUserResponse'
              example:
                externalId: ext-123abc
                email: user@example.com
                fullName: Alex Morgan
                permissionSets:
                - Admin
                department: Customer Success
                view: Standard View
                workspaces:
                - global workspace
                jobFunction: Other
        '400':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Invalid request body or missing required fields<br>

            <strong>Return:</strong> JSON error object

            </div>'
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  details:
                    type: array
                    items:
                      type: string
                  requestId:
                    type: string
        '401':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Authentication failed or missing credentials<br>

            <strong>Return:</strong> JSON error status object

            </div>'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                x-examples:
                  Example 1:
                    status: string
        '403':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Returned if the authenticated user lacks the "User Management" permission<br>

            <strong>Return:</strong> JSON error object

            </div>

            '
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  details:
                    type: string
                  requestId:
                    type: string
                x-examples:
                  Example 1:
                    code: integer
                    details: string
                    requestId: string
        '500':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            <strong>Description:</strong> Returned if there was an issue on the server side and user could not be updated.<br>

            </div>

            '
      security:
      - token: []
      servers:
      - url: https://uapi.demandbase.com
  /admin/v1/users:
    get:
      tags:
      - User Management
      summary: Get list of users
      description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        <h3>Overview</h3><br>

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

        </div>'
      parameters:
      - name: departments
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">comma separated list of departments<br><strong>Example:</strong> Marketing,Sales</div>'
        schema:
          type: string
      - name: views
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">comma separated list of views<br><strong>Example:</strong> Standard View,Marketing View</div>'
        schema:
          type: string
      - name: permissionSets
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">comma separated list of permission sets<br><strong>Example:</strong> General User,Admin</div>'
        schema:
          type: string
      - name: workspaces
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">comma separated list of workspaces (if enabled)<br><strong>Example:</strong> global workspace</div>'
        schema:
          type: string
      - name: pageNo
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;"><strong>Default:</strong> 1<br><strong>Example:</strong> 5</div>'
        schema:
          type: integer
      - name: pageSize
        in: query
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;"><strong>Default:</strong> 25<br><strong>Example:</strong> 25<br><strong>Max:</strong> 100</div>'
        schema:
          type: integer
      responses:
        '200':
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returns a paginated list of users.

            </div>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
              example:
                totalCount: 2
                data:
                - name: Alex Morgan
                  email: alex.morgan@example.com
                  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: jordan.lee@example.com
                  externalIds: []
                  permissionSets:
                  - General User
                  department: Marketing
                  view: Standard View
                  workspaces:
                  - Default workspace
                  date_created: '2023-11-02T08:15:30Z'
                  jobFunction: Marketing
        '400':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the user specification in the request does not match the required format.

            </div>'
        '401':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authentication credentials are missing or invalid

            </div>'
        '403':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authenticated user lacks the "User Management" permission

            </div>'
        '500':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if there was an issue on the server side and could not get list of users.

            </div>'
      security:
      - token: []
      servers:
      - url: https://uapi.demandbase.com
  /admin/v1/user/{id}:
    get:
      tags:
      - User Management
      summary: Get a user by external id
      description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        <h3>Overview</h3><br>

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

        </div>

        '
      parameters:
      - name: id
        in: path
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">An external client defined identifier for the user (set when creating the user)<br><strong>Example:</strong> dcb34525-2baa-4f54-8c11-9e6175ecbc74</div>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returns the requested user details matching the provided ID

            </div>'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserResponse'
              example:
                name: Alex Morgan
                email: user@example.com
                externalIds:
                - ext-123abc
                permissionSets:
                - Admin
                department: Customer Success
                view: Standard View
                workspaces:
                - Default workspace
                date_created: '2025-08-22T20:43:44.888Z'
                jobFunction: Other
        '400':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the user specification in the request body does not match the required format.

            </div>'
        '401':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authentication credentials are missing or invalid.

            </div>'
        '403':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authenticated user lacks the "User Management" permission

            </div>'
        '404':
          $ref: '#/components/responses/404errorNoUserFound'
        '500':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if there was an issue on the server side and could not find the user.

            </div>'
      security:
      - token: []
      servers:
      - url: https://uapi.demandbase.com
    delete:
      tags:
      - User Management
      summary: Delete user using external user id
      description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        <h3>Overview</h3><br>

        Deletes an existing <strong>user</strong> from your Demandbase account.

        </div>'
      operationId: delete-users
      parameters:
      - name: id
        in: path
        description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">An external client defined identifier for the user (set when creating the user)<br><strong>Example:</strong> dcb34525-2baa-4f54-8c11-9e6175ecbc74</div>'
        required: true
        schema:
          type: string
      responses:
        '204':
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the user is successfully deleted.

            </div>'
        '400':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the user specification in the request body does not match the required format.

            </div>'
        '401':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authentication credentials are missing or invalid.

            </div>'
        '403':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if the authenticated user lacks the "User Management" permission

            </div>'
        '404':
          $ref: '#/components/responses/404errorNoUserFound'
        '500':
          description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Returned if there was an issue on the server side and user could not be deleted.

            </div>'
      security:
      - token: []
      servers:
      - url: https://uapi.demandbase.com
components:
  responses:
    404errorNoUserFound:
      description: '<div style="background:#FFFFFF; border-left:4px solid red; border-top:1px solid #000000;border-right:1px solid #000000;border-bottom:1px solid #000000; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

        Returned if the provided external user id does not exist in DemandBase

        </div>'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorDto'
          examples:
            Example 1:
              $ref: '#/components/examples/errorNoUserFoundExample'
  schemas:
    UserListResponse:
      type: object
      properties:
        totalCount:
          type: integer
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserListItem'
      required:
      - totalCount
      - data
    UserListItem:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        externalIds:
          type: array
          items:
            type: string
        permissionSets:
          type: array
          items:
            type: string
        department:
          type: string
        view:
          type: string
        workspaces:
          type: array
          items:
            type: string
        date_created:
          type: string
          format: date-time
        jobFunction:
          type: string
    GetUserResponse:
      type: object
      properties:
        name:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            The user''s full name

            </div>'
        email:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            The user''s email address

            </div>'
        externalIds:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            A list of client defined user IDs

            </div>'
          items:
            type: string
        permissionSets:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Permissions of the user

            </div>'
          items:
            type: string
        department:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Department of the user

            </div>'
        view:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            View of the user

            </div>'
        workspaces:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Workspaces of the user if applicable

            </div>'
          items:
            type: string
        date_created:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Date when the user was created

            </div>'
          format: date-time
        jobFunction:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Job function of the user

            </div>'
    ErrorDto:
      type: object
      properties:
        errorCode:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            This is a error code

            </div>

            '
        errorMessage:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            A clear text description of the error

            </div>

            '
    NewUserResponse:
      type: object
      properties:
        fullName:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Name of the user

            </div>'
        email:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Email address of the user

            </div>'
        externalId:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            User ID in client''s system

            </div>'
        permissionSets:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Permissions of the user

            </div>'
          items:
            type: string
        department:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Department of the user

            </div>'
        view:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            View of the user

            </div>'
        workspaces:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Workspaces of the user if applicable

            </div>'
          items:
            type: string
        jobFunction:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Job function of the user

            </div>'
        dateCreated:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            Date when the user was created

            </div>'
          format: date
    User:
      type: object
      properties:
        fullName:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            The full name of the user.

            </div>'
        email:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            The email address of the user

            </div>'
        externalId:
          type: string
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            An external identifier for the user, such as user id in your user management system.

            </div>'
        permissionSets:
          type: array
          description: '<div style="background:#FFFFFF; border-left:4px solid #3bb273; padding:10px 14px; border-radius:4px; margin-bottom:10px;">

            An array of permission sets assigned to the user. These must match the permission sets configured in the DB1 platform.

            <br><strong>More info:</strong> <a href="https://support.demandbase.com/hc/en-us/articles/4408096348827-Create-and-Manage-Permission-Sets" target="_blank"><span style="color:blue">Create and Manage Permission Sets</span></a>

            </div>'
          items:
            type: string
        department:
          type: string
    

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/demandbase/refs/heads/main/openapi/demandbase-user-management-api-openapi.yml