Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: BlueConic REST API v2 Connections 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: Connections
description: BlueConic Connections lets you connect with other systems to synchronize customer data. The following methods allow you to retrieve the connection configuration and run history. Read more
paths:
/connections:
get:
tags:
- Connections
summary: Get all connections
description: Retrieves all connections.
operationId: getAllConnections
parameters:
- 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
- name: count
in: query
description: Specifies the number of results to return.
schema:
type: integer
format: int64
default: 10
example: 10
responses:
'200':
description: Returns the connections.
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
examples:
Response body:
description: Response body
value: "{\n \"connections\": [\n {\n \"allChannels\": false,\n \"creationDate\": \"2025-10-01T12:24:30.052Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"domains\": [\n {\n \"id\": \"8d7757cf-9ed0-4807-b974-089ebc0197d0\",\n \"name\": \"www.blueconic.test\"\n }\n ],\n \"id\": \"0a743354-a7ed-4e03-b662-6b3f033f7caf\",\n \"isEnabled\": true,\n \"lastModifiedDate\": \"2025-10-01T12:24:30.052Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"lastRun\": {\n \"endDate\": \"2025-10-22T11:28:14.295Z\",\n \"goalStatistics\": [\n {\n \"id\": \"SUCCESS\",\n \"values\": [\n \"1\"\n ]\n },\n {\n \"id\": \"FAILED\",\n \"values\": [\n \"0\"\n ]\n },\n {\n \"id\": \"TOTAL\",\n \"values\": [\n \"2\"\n ]\n }\n ],\n \"message\": \"<div class=\\\\\"bcpTask\\\\\">Import profiles into BlueConic</div><ul><li>Received 0 updates, created 19 profiles, 0 profiles unchanged, checked 19, the delta file is used.</li><li>See the last 5 profiles created: <a href=\\\\\"/blueconic/static/pages/main.html#id=a5b368bc-dfc0-4b7f-944a-3d7212b6bfb7&type=profile\\\\\">a5b368bc-d...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=9cb39103-7db4-4b3d-9661-62df3988d05d&type=profile\\\\\">9cb39103-7...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=4ee2900e-a761-4a6f-b494-b72125aa5621&type=profile\\\\\">4ee2900e-a...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=835de135-2306-49c1-bbdb-c33ded8ecfc3&type=profile\\\\\">835de135-2...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=31f97257-e994-4041-917c-d7fbb0a93dee&type=profile\\\\\">31f97257-e...</a></li></ul>\",\n \"runCount\": 1,\n \"runId\": \"20251022112756_16dc7081-8ffb-4957-b8bc-5113127125c3\",\n \"startDate\": \"2025-10-22T11:27:56.986Z\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Content collector\",\n \"pluginId\": \"connection_content_collector\",\n \"scheduleMode\": \"SCHEDULED\",\n \"tags\": [],\n \"targetChannels\": [\n {\n \"URLRestrictions\": [\n {\n \"pattern\": \"\",\n \"previewURL\": \"\",\n \"restrictionType\": \"RESTRICT\"\n }\n ],\n \"channelId\": \"653d3db6-8016-46e8-96a5-547feceb9d15\"\n }\n ]\n },\n {\n \"allChannels\": true,\n \"creationDate\": \"2025-10-01T11:54:49.802Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"domains\": [],\n \"id\": \"0ce3ccb7-1212-4364-bcc9-08e635a7883d\",\n \"isEnabled\": true,\n \"lastModifiedDate\": \"2025-10-01T12:32:09.434Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"lastRun\": {\n \"goalStatistics\": [],\n \"message\": \"<p>Running…</p>\",\n \"runCount\": 1,\n \"runId\": \"20251022112756_40b0e260-ae7a-4ab0-95d3-1dc25edbcba8\",\n \"startDate\": \"2025-10-22T11:27:56.986Z\",\n \"state\": \"RUNNING\"\n },\n \"name\": \"fb\",\n \"pluginId\": \"connection_facebook_leads\",\n \"scheduleMode\": \"SCHEDULED\",\n \"tags\": [],\n \"targetChannels\": []\n }\n ],\n \"itemsPerPage\": 10,\n \"startIndex\": 0,\n \"totalPages\": 1,\n \"totalResults\": 2\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:connections
/connections/{connection}:
get:
tags:
- Connections
summary: Get one connection
description: Retrieves a single connection.
operationId: getOneConnection
parameters:
- name: connection
in: path
description: The ID of the connection.
required: true
schema:
type: string
responses:
'200':
description: Returns the connection.
content:
application/json:
schema:
$ref: '#/components/schemas/Connection'
examples:
Response body:
description: Response body
value: "{\n \"allChannels\": false,\n \"creationDate\": \"2025-10-01T12:24:30.052Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"description\": \"\",\n \"domains\": [\n {\n \"id\": \"8d7757cf-9ed0-4807-b974-089ebc0197d0\",\n \"name\": \"www.blueconic.test\"\n }\n ],\n \"id\": \"0a743354-a7ed-4e03-b662-6b3f033f7caf\",\n \"isEnabled\": true,\n \"lastModifiedDate\": \"2025-10-01T12:24:30.052Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"lastRun\": {\n \"endDate\": \"2025-10-22T11:28:14.295Z\",\n \"goalStatistics\": [\n {\n \"id\": \"SUCCESS\",\n \"values\": [\n \"1\"\n ]\n },\n {\n \"id\": \"FAILED\",\n \"values\": [\n \"0\"\n ]\n },\n {\n \"id\": \"TOTAL\",\n \"values\": [\n \"2\"\n ]\n }\n ],\n \"message\": \"<div class=\\\\\"bcpTask\\\\\">Import profiles into BlueConic</div><ul><li>Received 0 updates, created 19 profiles, 0 profiles unchanged, checked 19, the delta file is used.</li><li>See the last 5 profiles created: <a href=\\\\\"/blueconic/static/pages/main.html#id=a5b368bc-dfc0-4b7f-944a-3d7212b6bfb7&type=profile\\\\\">a5b368bc-d...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=9cb39103-7db4-4b3d-9661-62df3988d05d&type=profile\\\\\">9cb39103-7...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=4ee2900e-a761-4a6f-b494-b72125aa5621&type=profile\\\\\">4ee2900e-a...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=835de135-2306-49c1-bbdb-c33ded8ecfc3&type=profile\\\\\">835de135-2...</a>, <a href=\\\\\"/blueconic/static/pages/main.html#id=31f97257-e994-4041-917c-d7fbb0a93dee&type=profile\\\\\">31f97257-e...</a></li></ul>\",\n \"runCount\": 1,\n \"runId\": \"20251022112756_16dc7081-8ffb-4957-b8bc-5113127125c3\",\n \"startDate\": \"2025-10-22T11:27:56.986Z\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Content collector\",\n \"pluginId\": \"connection_content_collector\",\n \"scheduleMode\": \"SCHEDULED\",\n \"tags\": [],\n \"targetChannels\": [\n {\n \"URLRestrictions\": [\n {\n \"pattern\": \"\",\n \"previewURL\": \"\",\n \"restrictionType\": \"RESTRICT\"\n }\n ],\n \"channelId\": \"653d3db6-8016-46e8-96a5-547feceb9d15\"\n }\n ]\n}"
'401':
description: Authentication failed (unauthorized).
'403':
description: Authorization failed (incorrect permissions).
'404':
description: The connection doesn't exist.
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:connections
/connections/{connection}/runs:
get:
tags:
- Connections
summary: Get the run history of a batch connection
description: Returns the run history of a batch connection.
operationId: getConnectionRuns
parameters:
- name: connection
in: path
description: The ID of the connection.
required: true
schema:
type: string
- 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
- name: count
in: query
description: Specifies the number of results to return.
schema:
type: integer
format: int64
default: 10
example: 10
responses:
'200':
description: Returns the history of a batch connection.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionStatus'
examples:
Response body:
description: Response body
value: "{\n \"itemsPerPage\": 10,\n \"runs\": [\n {\n \"endDate\": \"2025-09-24T13:47:37.909Z\",\n \"goalStatistics\": [\n {\n \"id\": \"SUCCESS\",\n \"values\": [\n \"1\"\n ]\n },\n {\n \"id\": \"FAILED\",\n \"values\": [\n \"0\"\n ]\n },\n {\n \"id\": \"TOTAL\",\n \"values\": [\n \"2\"\n ]\n }\n ],\n \"message\": \"<div class=\\\\\"bcpTask\\\\\">Import profiles into BlueConic</div><ul><li>Received 0 updates, created 0 profiles, 0 profiles unchanged, checked 199,836, the delta file is used.</li></ul>\",\n \"runCount\": 2,\n \"runId\": \"20250924134648_b5236652-b6d3-44ee-8f5b-6f5970b3bb3b\",\n \"startDate\": \"2025-09-24T13:46:48.107Z\",\n \"state\": \"FINISHED\"\n },\n {\n \"endDate\": \"2025-09-24T13:44:43.204Z\",\n \"goalStatistics\": [\n {\n \"id\": \"SUCCESS\",\n \"values\": [\n \"0\"\n ]\n },\n {\n \"id\": \"FAILED\",\n \"values\": [\n \"1\"\n ]\n },\n {\n \"id\": \"TOTAL\",\n \"values\": [\n \"2\"\n ]\n }\n ],\n \"message\": \"<div class=\\\\\"bcpError\\\\\"><div class=\\\\\"bcpTask\\\\\">Import profiles into BlueConic</div><ul> <li>Missing required setting: importMatching</li> </ul></div><div>Review the run log for more information.</div>\",\n \"runCount\": 1,\n \"runId\": \"20250924134435_b5236652-b6d3-44ee-8f5b-6f5970b3bb3b\",\n \"startDate\": \"2025-09-24T13:44:35.250Z\",\n \"state\": \"FINISHED\"\n }\n ],\n \"startIndex\": 0,\n \"totalPages\": 1,\n \"totalResults\": 2\n}"
'401':
description: Authentication failed (unauthorized).
'403':
description: Authorization failed (incorrect permissions).
'404':
description: The connection doesn't exist.
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:connections
components:
schemas:
UrlRestriction:
type: object
description: URL restriction for a target channel.
properties:
pattern:
type: string
description: The URL pattern.
previewURL:
type: string
description: The preview URL.
restrictionType:
type: string
description: The restriction type.
enum:
- RESTRICT
- EXCLUDE
simpleDomain:
type: object
description: The domain.
properties:
id:
type: string
description: Unique identifier.
name:
type: string
description: Name of this object.
readOnly: true
ConnectionStatus:
type: object
description: The status of a connection run
properties:
endDate:
type: string
format: date-time
description: The end date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
readOnly: true
goalStatistics:
type: array
description: The goal statistics
items:
$ref: '#/components/schemas/property'
lane:
type: string
description: The lane in which this run was executed
enum:
- REGULAR
- REGULAR2
- REGULAR3
- REGULAR4
- REGULAR5
- REGULAR6
- REGULAR7
- REGULAR8
- EXPRESS
- RUN_NOW
- CONTINUOUS
message:
type: string
description: The message of the run
runCount:
type: integer
format: int64
description: The run count
runId:
type: string
description: The run id
startDate:
type: string
format: date-time
description: The start date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
readOnly: true
state:
type: string
description: The state of the run
enum:
- STARTING
- RUNNING
- FINISHED
- FAILED
- STOPPING
- STOPPED
Connection:
type: object
description: A connection
properties:
allChannels:
type: boolean
description: Indicates whether the executable is active on all channels
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
items:
$ref: '#/components/schemas/simpleDomain'
id:
type: string
description: The object ID.
isEnabled:
type: boolean
description: Indicates whether it is enabled
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'
lastRun:
$ref: '#/components/schemas/status'
name:
type: string
description: The object name.
pluginId:
type: string
description: The plugin id
requiredPermission:
type: string
description: The required permission for this executable
roles:
type: array
description: Roles allowed to edit this connection; empty means no role-based restriction
items:
$ref: '#/components/schemas/SimpleRoleBean'
scheduleMode:
type: string
description: The scheduling mode
enum:
- SCHEDULED
- CONTINUOUS
tags:
type: array
description: The tags (i.e. labels).
example: Address
items:
type: string
description: The tags (i.e. labels).
example: Address
targetChannels:
type: array
description: The channels.
items:
$ref: '#/components/schemas/targetChannels'
required:
- roles
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.
status:
type: object
description: Notebook run status.
properties:
endDate:
type: string
format: date-time
description: The end date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
readOnly: true
goalStatistics:
type: array
description: The goal statistics
items:
$ref: '#/components/schemas/property'
lane:
type: string
description: The lane in which this run was executed
enum:
- REGULAR
- REGULAR2
- REGULAR3
- REGULAR4
- REGULAR5
- REGULAR6
- REGULAR7
- REGULAR8
- EXPRESS
- RUN_NOW
- CONTINUOUS
message:
type: string
description: The message of the run
runCount:
type: integer
format: int64
description: The run count
runId:
type: string
description: The run id
startDate:
type: string
format: date-time
description: The start date of the run. Datetime in UTC in the https://www.ietf.org/rfc/rfc3339.txt format, example = "2025-01-22T11:21:33.872Z".
readOnly: true
state:
type: string
description: The state of the run
enum:
- STARTING
- RUNNING
- FINISHED
- FAILED
- STOPPING
- STOPPED
property:
type: object
description: A property consisting of an ID and a list of values.
properties:
id:
type: string
description: The ID of the property.
values:
type: array
description: Values for this property.
items:
type: string
description: Values for this property.
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
targetChannels:
type: object
description: Target channel.
properties:
URLRestrictions:
type: array
items:
$ref: '#/components/schemas/UrlRestriction'
channelId:
type: string
description: The ID of the channel.
required:
- URLRestrictions
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