BlueConic

BlueConic Users API

Users are the people who have access to the BlueConic environment. [Read more](https://support.blueconic.com/hc/en-us/articles/360000013785-Users)

GitHub OpenAPI

Operations 2

GET /users Get all users #
GET /users/{user} Get one user #

Documentation

📖
Documentation
https://support.blueconic.com/en/articles/248008-overview-blueconic-rest-api
📖
GettingStarted
https://support.blueconic.com/en/articles/248009-using-the-blueconic-rest-api-v2
📖
Authentication
https://support.blueconic.com/en/articles/247557-authorizing-applications-granting-external-applications-to-access-blueconic

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/blueconic/refs/heads/main/openapi/blueconic-users-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/blueconic/refs/heads/main/overlays/blueconic-users-api-overlay.yaml
🔗
AuthorizationCodeFlow
https://support.blueconic.com/en/articles/247559-authorizing-applications-using-the-authorization-code-flow
🔗
ClientCredentialsFlow
https://support.blueconic.com/en/articles/247558-authorizing-applications-using-the-client-credentials-flow

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/blueconic-users-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

blueconic-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BlueConic REST API v2 Users API
  description: Welcome to the BlueConic REST API v2.
  termsOfService: https://www.blueconic.com/blueconic-terms-and-conditions
  contact:
    name: Contact us
    url: https://support.blueconic.com/hc/en-us/requests/new
  license:
    name: BlueConic
    url: https://github.com/blueconic/openapi/blob/main/LICENSE.MD
  version: '100.0'
servers:
- url: https://{blueconicHostname}/rest/v2
  description: The BlueConic server
  variables:
    blueconicHostname:
      description: BlueConic server hostname, e.g. 'tenant.blueconic.net'
      default: tenantname
tags:
- name: Users
  description: Users are the people who have access to the BlueConic environment. Read more
paths:
  /users:
    get:
      tags:
      - Users
      summary: Get all users
      description: Retrieves all users.
      operationId: getAllUsers
      parameters:
      - name: count
        in: query
        description: Specifies the number of results to return.
        schema:
          type: integer
          format: int64
          default: 20
          example: 10
      - name: startIndex
        in: query
        description: Specifies the index of the first item to include in the result.
        schema:
          type: integer
          format: int64
          default: 0
          example: 0
      responses:
        '200':
          description: Returns the users.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/users'
              examples:
                Response body:
                  description: Response body
                  value: "{\n  \"itemsPerPage\": 1,\n  \"startIndex\": 0,\n  \"totalPages\": 37,\n  \"totalResults\": 74,\n  \"users\": [\n    {\n      \"creationDate\": \"2024-02-29T15:50:20.489Z\",\n      \"creator\": {\n        \"fullName\": \"example_user1@blueconic.com\",\n        \"userName\": \"example_user1@blueconic.com\"\n      },\n      \"description\": \"\",\n      \"domains\": [\n        {\n          \"id\": \"6748f4a6-cf42-42f0-bbae-05ce936dfc7f\",\n          \"name\": \"www.blueconic.test\"\n        }\n      ],\n      \"id\": \"admin@blueconic.com\",\n      \"hasAllDomains\": false,\n      \"lastLoginDate\": \"2024-09-27T18:30:35.663Z\",\n      \"lastModifiedDate\": \"2024-02-29T15:50:20.489Z\",\n      \"lastModifiedUser\": {\n        \"fullName\": \"admin@blueconic.com\",\n        \"userName\": \"admin@blueconic.com\"\n      },\n      \"name\": \"\",\n      \"permissions\": [\n        \"CREATE_POSITIONS\",\n        \"MANAGE_APPLICATIONS\",\n        \"READ_AUDIT_EVENTS\",\n        \"AUTHORIZE_APPLICATIONS\",\n        \"MANAGE_SUPPORT_ACCESS_SETTINGS\",\n        \"APPLY_BULK_OPERATIONS\",\n        \"MANAGE_PROFILE_COMPOSITION_RULES\",\n        \"MANAGE_API_V1_ACCESS_KEYS\",\n        \"MANAGE_CONNECTIONS\",\n        \"MANAGE_DIALOGUES\",\n        \"MANAGE_GROUPS\",\n        \"MANAGE_PROFILES\",\n        \"MANAGE_EMAIL_NOTIFICATIONS\",\n        \"READ_EXACT_PROFILE_STATISTICS\",\n        \"MANAGE_GENERAL_SETTINGS\",\n        \"READ_GROUPS\",\n        \"MANAGE_INSIGHTS\",\n        \"MANAGE_IP_BASED_ACCESS_SETTINGS\",\n        \"MANAGE_LIFECYCLES\",\n        \"MANAGE_LISTENERS\",\n        \"MANAGE_PROFILE_MERGE_RULES\",\n        \"MANAGE_NOTEBOOKS\",\n        \"USE_NOTEBOOK_EDITOR\",\n        \"MANAGE_OBJECTIVES\",\n        \"PERSONAL\",\n        \"MANAGE_PII_VALUES\",\n        \"MANAGE_PLUGINS\",\n        \"MANAGE_PRIVACY_SETTINGS\",\n        \"MANAGE_PROPERTIES\",\n        \"READ_PROFILES\",\n        \"MANAGE_ROLES\",\n        \"READ_SECURITY_SETTINGS\",\n        \"MANAGE_SECURITY_SETTINGS\",\n        \"MANAGE_SEGMENTS\",\n        \"USE_SIMULATOR\",\n        \"MANAGE_SINGLE_SIGN_ON_SETTINGS\",\n        \"MANAGE_TEMPLATES\",\n        \"MANAGE_TIMELINE_EVENT_ROLLUPS\",\n        \"MANAGE_TIMELINE_EVENT_TYPES\",\n        \"READ_INACTIVITY_SETTINGS\",\n        \"MANAGE_INACTIVITY_SETTINGS\",\n        \"MANAGE_TRACKERS\",\n        \"MANAGE_CHANNELS\",\n        \"MANAGE_USERS\"\n      ],\n      \"roles\": [\n        {\n          \"id\": \"35718e9a-f8d3-4d2d-8501-a020c563cc25\",\n          \"name\": \"Application Manager\"\n        }\n      ],\n      \"tags\": []\n    }\n  ]\n}"
        '401':
          description: Authentication failed (unauthorized).
        '403':
          description: Authorization failed (incorrect permissions).
        '503':
          description: The server is too busy to handle the request.
      security:
      - oauth2:
        - read:users
  /users/{user}:
    get:
      tags:
      - Users
      summary: Get one user
      description: Retrieves a single user.
      operationId: getOneUser
      parameters:
      - name: user
        in: path
        description: The ID of the user.
        required: true
        schema:
          type: string
        examples:
          Email address:
            description: Email address
            value: user.name@domain.com
      responses:
        '200':
          description: Returns the user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlueConicUserBean'
              examples:
                Response body:
                  description: Response body
                  value: "{\n  \"creationDate\": \"2024-11-20T14:35:49.480Z\",\n  \"creator\": {\n    \"fullName\": \"Admin\",\n    \"userName\": \"admin@blueconic.com\"\n  },\n  \"description\": \"a description\",\n  \"domains\": [\n    {\n      \"id\": \"6748f4a6-cf42-42f0-bbae-05ce936dfc7f\",\n      \"name\": \"www.blueconic.test\"\n    }\n  ],\n  \"id\": \"john@blueconic.com\",\n  \"hasAllDomains\": false,\n  \"lastModifiedDate\": \"2024-11-29T12:37:30.145Z\",\n  \"lastModifiedUser\": {\n    \"fullName\": \"Admin\",\n    \"userName\": \"admin@blueconic.com\"\n  },\n  \"name\": \"John Doe\",\n  \"permissions\": [\n    \"CREATE_POSITIONS\",\n    \"MANAGE_APPLICATIONS\",\n    \"READ_AUDIT_EVENTS\",\n    \"AUTHORIZE_APPLICATIONS\",\n    \"MANAGE_SUPPORT_ACCESS_SETTINGS\",\n    \"APPLY_BULK_OPERATIONS\",\n    \"MANAGE_PROFILE_COMPOSITION_RULES\",\n    \"MANAGE_API_V1_ACCESS_KEYS\",\n    \"MANAGE_CONNECTIONS\",\n    \"MANAGE_DIALOGUES\",\n    \"MANAGE_GROUPS\",\n    \"MANAGE_PROFILES\",\n    \"MANAGE_EMAIL_NOTIFICATIONS\",\n    \"READ_EXACT_PROFILE_STATISTICS\",\n    \"MANAGE_GENERAL_SETTINGS\",\n    \"READ_GROUPS\",\n    \"MANAGE_INSIGHTS\",\n    \"MANAGE_IP_BASED_ACCESS_SETTINGS\",\n    \"MANAGE_LIFECYCLES\",\n    \"MANAGE_LISTENERS\",\n    \"MANAGE_PROFILE_MERGE_RULES\",\n    \"MANAGE_NOTEBOOKS\",\n    \"USE_NOTEBOOK_EDITOR\",\n    \"MANAGE_OBJECTIVES\",\n    \"PERSONAL\",\n    \"MANAGE_PII_VALUES\",\n    \"MANAGE_PLUGINS\",\n    \"MANAGE_PRIVACY_SETTINGS\",\n    \"MANAGE_PROPERTIES\",\n    \"READ_PROFILES\",\n    \"MANAGE_ROLES\",\n    \"READ_SECURITY_SETTINGS\",\n    \"MANAGE_SECURITY_SETTINGS\",\n    \"MANAGE_SEGMENTS\",\n    \"USE_SIMULATOR\",\n    \"MANAGE_SINGLE_SIGN_ON_SETTINGS\",\n    \"MANAGE_TEMPLATES\",\n    \"MANAGE_TIMELINE_EVENT_ROLLUPS\",\n    \"MANAGE_TIMELINE_EVENT_TYPES\",\n    \"READ_INACTIVITY_SETTINGS\",\n    \"MANAGE_INACTIVITY_SETTINGS\",\n    \"MANAGE_TRACKERS\",\n    \"MANAGE_CHANNELS\",\n    \"MANAGE_USERS\"\n  ],\n  \"roles\": [\n    {\n      \"id\": \"3b694f5b-7a9e-497d-9b4b-fab9a7620216\",\n      \"name\": \"Application Manager\"\n    },\n    {\n      \"id\": \"3d7c5aa2-2fe1-4bfe-af41-fb914dfb94b3\",\n      \"name\": \"Content Manager\"\n    }\n  ],\n  \"tags\": []\n}"
        '401':
          description: Authentication failed (unauthorized).
        '403':
          description: Authorization failed (incorrect permissions).
        '404':
          description: The user doesn't exist.
        '503':
          description: The server is too busy to handle the request.
      security:
      - oauth2:
        - read:users
components:
  schemas:
    simpleDomain:
      type: object
      description: The domain.
      properties:
        id:
          type: string
          description: Unique identifier.
        name:
          type: string
          description: Name of this object.
      readOnly: true
    SimpleRoleBean:
      type: object
      description: A role with id and name.
      properties:
        id:
          type: string
          description: Unique identifier of the role.
        name:
          type: string
          description: Name of the role.
    UserBean:
      type: object
      description: BlueConic user.
      properties:
        fullName:
          type: string
          description: The full name of the user.
        userName:
          type: string
          description: The username.
      readOnly: true
    users:
      type: object
      properties:
        itemsPerPage:
          type: integer
          format: int32
          description: Number of results per page.
          readOnly: true
        startIndex:
          type: integer
          format: int32
          description: The start index.
          readOnly: true
        totalPages:
          type: integer
          format: int32
          description: The total number of pages.
          readOnly: true
        totalResults:
          type: integer
          format: int32
          description: The total number of results.
          readOnly: true
        users:
          type: array
          items:
            $ref: '#/components/schemas/BlueConicUserBean'
    BlueConicUserBean:
      type: object
      description: The user.
      properties:
        creationDate:
          type: string
          format: date-time
          description: The creation date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
          readOnly: true
        creator:
          $ref: '#/components/schemas/UserBean'
        description:
          type: string
          description: The description.
        domains:
          type: array
          description: The domains the user has access to. Only available if `hasAllDomains` is false.
          items:
            $ref: '#/components/schemas/simpleDomain'
          readOnly: true
          uniqueItems: true
        hasAllDomains:
          type: boolean
          description: Indicates if the user has access to all domains. If false, the configured domains are returned in the `domains` property.
          readOnly: true
        id:
          type: string
          description: The object ID.
        isActive:
          type: boolean
          description: Indicates if the user is active or inactive and can no longer login.
        lastLoginDate:
          type: string
          format: date-time
          description: The last login date.
        lastModifiedDate:
          type: string
          format: date-time
          description: The last modified date of the object. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
          readOnly: true
        lastModifiedUser:
          $ref: '#/components/schemas/UserBean'
        name:
          type: string
          description: The object name.
        permissions:
          type: array
          description: The permissions assigned to this user.
          items:
            type: string
            description: The permissions assigned to this user.
        roles:
          type: array
          description: The roles assigned to this user.
          items:
            $ref: '#/components/schemas/SimpleRoleBean'
          uniqueItems: true
        tags:
          type: array
          description: The tags (i.e. labels).
          example: Address
          items:
            type: string
            description: The tags (i.e. labels).
            example: Address
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'Authenticates a registered OAuth 2.0 client. The Authorization code flow and Client credentials flow are supported. Make sure to select the correct flow based on which flow the registered client supports. The client id and client secret can be found in BlueConic by opening the registered client under *Settings* > *Access management* > *Applications*.<br/>**NOTE:** When using the Authorization code flow, the redirect URL of the registered client in BlueConic must be set to `https://rest.apidoc.blueconic.com/oauth-receiver.html` and ''Send Proof Key for Code Exchange'' must be enabled.<br/><br/>To use a Bearer token for authentication, follow these steps: <br/>1. Acquire the token through authentication.<br/>2. Include the token in the request''s Authorization header as Bearer \<token\>.<br/>3. Send the request to access protected resources.<br/>4. Handle token expiration by refreshing or obtaining a new token.'
      flows:
        clientCredentials:
          tokenUrl: /rest/v2/oauth/token
        authorizationCode:
          authorizationUrl: /rest/v2/oauth/authorize
          tokenUrl: /rest/v2/oauth/token
          refreshUrl: /rest/v2/oauth/token