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 Properties 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: Properties
description: The following methods allow you to retrieve and update Profile Properties and Group Properties.
paths:
/profileProperties/{propertyId}:
get:
tags:
- Properties
summary: Get one property
description: Retrieves a single profile or group property.
operationId: getOneProfileOrGroupProperty
parameters:
- name: propertyId
in: path
description: The ID of the property.
required: true
schema:
type: string
examples:
Browser name (most recent):
description: Browser name (most recent)
value: currentbrowsername
Operating system version (all):
description: Operating system version (all)
value: osversion
responses:
'200':
description: ' Returns the property.'
content:
application/json:
schema:
$ref: '#/components/schemas/profileProperty'
examples:
Response body (profile property):
description: Response body (profile property)
value: "{\n \"availableForSegmentation\" : true,\n \"canRead\" : true,\n \"canWrite\" : true,\n \"createNewProfile\" : false,\n \"creationDate\" : \"2023-03-22T09:33:26.319Z\",\n \"creator\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"dataSensitivity\" : \"NON_PII\",\n \"description\" : \"Test description.\",\n \"filterType\" : \"RANGE\",\n \"id\" : \"test_property\",\n \"indexed\" : false,\n \"isIdProperty\" : false,\n \"lastModifiedDate\" : \"2023-03-22T09:41:21.491Z\",\n \"lastModifiedUser\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"links\" : [ {\n \"href\" : \"https://localhost/rest/v2/profileProperties/test_property\",\n \"rel\" : \"alt\",\n \"type\" : \"application/json\"\n } ],\n \"mergeStrategy\" : \"HIGHEST\",\n \"name\" : \"Test property\",\n \"permissionLevel\" : \"ANONYMOUS\",\n \"precision\" : 0,\n \"profileCount\" : 0,\n \"showInUI\" : true,\n \"tags\" : [ \"Tech\", \"Metrics\" ],\n \"totalProfileCount\" : 130300,\n \"useValidation\" : true,\n \"values\" : [ ]\n}"
Response body (group property):
description: Response body (group property)
value: "{\n \"availableForSegmentation\": false,\n \"canRead\": true,\n \"canWrite\": true,\n \"compositionStrategy\": \"BOTH\",\n \"createNewProfile\": false,\n \"creationDate\": \"2025-09-25T11:51:34.249Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"dataSensitivity\": \"NON_PII\",\n \"description\": \"\",\n \"filterType\": \"SELECT\",\n \"groupTypeId\": \"company\",\n \"id\": \"company_name\",\n \"indexed\": false,\n \"isIdProperty\": false,\n \"lastModifiedDate\": \"2025-09-25T11:51:34.249Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"links\": [\n {\n \"href\": \"https://localhost/rest/v2/profileProperties/company_name\",\n \"rel\": \"alt\",\n \"type\": \"application/json\"\n }\n ],\n \"mergeStrategy\": \"BOTH\",\n \"name\": \"Company name\",\n \"permissionLevel\": \"ANONYMOUS\",\n \"precision\": 0,\n \"profileCount\": 0,\n \"showInUI\": true,\n \"tags\": [],\n \"totalProfileCount\": 1,\n \"useValidation\": true,\n \"values\": []\n}"
'401':
description: Authentication failed (unauthorized).
'404':
description: ' The specified property doesn''t exist.'
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:profile-properties
put:
tags:
- Properties
summary: Create/update property
operationId: createUpdateProfileOrGroupProperty
parameters:
- name: propertyId
in: path
description: The ID of the property to create or update. A valid id may consist of letters, numbers, hyphens (-), and underscores (_) and is at least one character long.
required: true
schema:
type: string
examples:
Browser name (most recent):
description: Browser name (most recent)
value: currentbrowsername
requestBody:
description: Creates or updates a property (either for profiles or groups).
content:
application/json:
schema:
$ref: '#/components/schemas/profileProperty'
examples:
Example request body (profile property):
description: Example request body (profile property)
value: "{\n \"id\": \"test_property\",\n \"indexed\": false,\n \"createNewProfile\": false,\n \"availableForSegmentation\": true,\n \"showInUI\": true,\n \"canRead\": true,\n \"canWrite\": true,\n \"filterType\": \"RANGE\",\n \"description\": \"The profile property description\",\n \"permissionLevel\": \"PERSONAL\",\n \"mergeStrategy\": \"BOTH\",\n \"dataSensitivity\": \"NON_PII\",\n \"tags\": [],\n \"values\": [],\n \"precision\": 0,\n \"unit\": {\n \"id\": \"views\",\n \"name\": {\n \"label\": [\n {\n \"content\": \"Views\",\n \"locale\": \"en_US\"\n },\n {\n \"content\": \"Impressies\",\n \"locale\": \"nl_NL\"\n }\n ]\n }\n },\n \"name\": \"Test property\"\n}"
Example request body (group property):
description: Example request body (group property)
value: "{\n \"id\": \"company_new_property\",\n \"availableForSegmentation\": true,\n \"showInUI\": true,\n \"filterType\": \"CURRENCY\",\n \"description\": \"My description\",\n \"dataSensitivity\": \"PII\",\n \"tags\": [],\n \"currency\": {\n \"isoCode\": \"USD\"\n },\n \"groupTypeId\": \"company\",\n \"unit\": {\n \"id\": \"\"\n },\n \"name\": \"new property\"\n}"
required: true
responses:
'200':
description: Returns the created / updated property.
content:
application/json:
schema:
$ref: '#/components/schemas/profileProperty'
examples:
Response body with currency:
description: Response body with currency
value: "{\n \"availableForSegmentation\" : true,\n \"canRead\" : true,\n \"canWrite\" : true,\n \"createNewProfile\" : false,\n \"creationDate\" : \"2023-03-22T09:43:58.910Z\",\n \"creator\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"currency\" : {\n \"isoCode\" : \"USD\",\n \"name\" : \"United States dollar\",\n \"precision\" : 2,\n \"symbol\" : \"\\$\"\n },\n \"dataSensitivity\" : \"NON_PII\",\n \"description\" : \"The description for the currency\",\n \"filterType\" : \"CURRENCY\",\n \"id\" : \"test_currency\",\n \"indexed\" : false,\n \"isIdProperty\" : false,\n \"lastModifiedDate\" : \"2023-03-22T09:43:58.910Z\",\n \"lastModifiedUser\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"links\" : [ {\n \"href\" : \"https://localhost/rest/v2/profileProperties/test_currency\",\n \"rel\" : \"alt\",\n \"type\" : \"application/json\"\n } ],\n \"mergeStrategy\" : \"BOTH\",\n \"name\" : \"Test currency\",\n \"permissionLevel\" : \"ANONYMOUS\",\n \"precision\" : 2,\n \"profileCount\" : 0,\n \"showInUI\" : true,\n \"tags\" : [ \"Metrics\" ],\n \"totalProfileCount\" : 130300,\n \"useValidation\" : true,\n \"values\" : [ ]\n}"
Response body with unit pixel:
description: Response body with unit pixel
value: "{\n \"availableForSegmentation\" : true,\n \"canDelete\" : true,\n \"canRead\" : true,\n \"canWrite\" : true,\n \"createNewProfile\" : false,\n \"creationDate\" : \"2023-03-22T09:47:26.491Z\",\n \"creator\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"dataSensitivity\" : \"NON_PII\",\n \"description\" : \"Test unit pixel description.\",\n \"favorite\" : false,\n \"filterType\" : \"RANGE\",\n \"id\" : \"test_unit_pixels\",\n \"indexed\" : false,\n \"isIdProperty\" : false,\n \"lastModifiedDate\" : \"2023-03-22T09:47:26.491Z\",\n \"lastModifiedUser\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"links\" : [ {\n \"href\" : \"https://localhost/rest/v2/profileProperties/test_unit_pixels\",\n \"rel\" : \"alt\",\n \"type\" : \"application/json\"\n } ],\n \"mergeStrategy\" : \"HIGHEST\",\n \"name\" : \"Test unit pixels\",\n \"permissionLevel\" : \"ANONYMOUS\",\n \"precision\" : 0,\n \"profileCount\" : 0,\n \"readOnly\" : false,\n \"showInUI\" : true,\n \"tags\" : [ \"Tech\", \"Metrics\" ],\n \"totalProfileCount\" : 130300,\n \"unit\" : {\n \"id\" : \"pixels\",\n \"name\" : {\n \"label\" : [ {\n \"content\" : \"Pixels\",\n \"locale\" : \"nl_NL\"\n }, {\n \"content\" : \"Pixels\",\n \"locale\" : \"en_US\"\n } ]\n }\n },\n \"useValidation\" : true,\n \"values\" : [ ]\n}"
'400':
description: 'The JSON is invalid or: Either, the specified property exists but is created by a plugin and cannot be created / updated through REST, or the id, filtertype, permission level, or merge strategy is invalid.'
'401':
description: Authentication failed (unauthorized).
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- write:profile-properties
delete:
tags:
- Properties
summary: Delete property
description: Deletes a profile or group property.
operationId: deleteProfileOrGroupProperty
parameters:
- name: propertyId
in: path
description: The ID of the property.
required: true
schema:
type: string
examples:
Browser name (most recent):
description: Browser name (most recent)
value: currentbrowsername
Operating system version (all):
description: Operating system version (all)
value: osversion
responses:
'200':
description: Returns the deleted property.
content:
application/json:
schema:
$ref: '#/components/schemas/profileProperty'
examples:
Response body:
description: Response body
value: "{\n \"availableForSegmentation\" : true,\n \"canRead\" : true,\n \"canWrite\" : true,\n \"createNewProfile\" : false,\n \"creationDate\" : \"2023-03-22T09:33:26.319Z\",\n \"creator\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"dataSensitivity\" : \"NON_PII\",\n \"description\" : \"Test description.\",\n \"filterType\" : \"RANGE\",\n \"id\" : \"test_property\",\n \"indexed\" : false,\n \"isIdProperty\" : false,\n \"lastModifiedDate\" : \"2023-03-22T09:41:21.491Z\",\n \"lastModifiedUser\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"links\" : [ {\n \"href\" : \"https://localhost/rest/v2/profileProperties/test_property\",\n \"rel\" : \"alt\",\n \"type\" : \"application/json\"\n } ],\n \"mergeStrategy\" : \"HIGHEST\",\n \"name\" : \"Test property\",\n \"permissionLevel\" : \"ANONYMOUS\",\n \"precision\" : 0,\n \"profileCount\" : 0,\n \"showInUI\" : true,\n \"tags\" : [ \"Tech\", \"Metrics\" ],\n \"totalProfileCount\" : 130300,\n \"useValidation\" : true,\n \"values\" : [ ]\n}"
'401':
description: Authentication failed (unauthorized).
'404':
description: ' The specified property doesn''t exist.'
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- write:profile-properties
/profileProperties:
get:
tags:
- Properties
summary: Get all properties
description: Retrieves the properties for profiles (no `groupTypeId`) or groups (depending on the passed `groupTypeId`).
operationId: getAllProfileOrGroupProperties
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: 10
- name: filterType
in: query
description: The filterType of the properties e.g. "SELECT","RANGE", AND "DATETIME". Multiple values are allowed.
schema:
type: array
enum:
- RANGE
- CURRENCY
- DECIMAL
- SELECT
- EMAIL
- DATETIME
example: DATETIME
items:
type: string
enum:
- RANGE
- CURRENCY
- DECIMAL
- SELECT
- EMAIL
- DATETIME
example: DATETIME
- name: filterValue
in: query
description: 'If specified, the name of the profile properties must match the value. '
schema:
type: string
- name: groupTypeId
in: query
description: The group type IDs to retrieve the properties for.
schema:
type: array
example: household
items:
type: string
example: household
responses:
'200':
description: ' Returns the property.'
content:
application/json:
schema:
$ref: '#/components/schemas/profileProperties'
examples:
Response body (profile properties):
description: Response body (profile properties)
value: "{\n \"itemsPerPage\": 20,\n \"startIndex\" : 0,\n \"totalPages\" : 8,\n \"totalResults\" : 144,\n \"links\": {\n \"links\": [{\n \"href\": \"https://localhost/rest/v2/profileProperties\",\n \"rel\": \"alt\",\n \"type\": \"application/json\"\n }]\n },\n \"profileProperties\": [{\n \"availableForSegmentation\": true,\n \"canRead\": true,\n \"canWrite\": true,\n \"createNewProfile\": false,\n \"creationDate\": \"2023-03-20T13:53:34.687Z\",\n \"dataSensitivity\": \"NON_PII\",\n \"description\": \"The unique Facebook Ads custom audience IDs to which a user has been added by BlueConic.\",\n \"filterType\": \"SELECT\",\n \"id\": \"_facebookAdsAudiences\",\n \"indexed\": false,\n \"isIdProperty\": false,\n \"lastModifiedDate\": \"2023-03-20T13:53:34.687Z\",\n \"links\": [{\n \"href\": \"https://localhost/rest/v2/profileProperties/_facebookAdsAudiences?alt=application%2Fjson\",\n \"rel\": \"self\",\n \"type\": \"application/json\"\n }],\n \"mergeStrategy\": \"BOTH\",\n \"name\": \"Facebook Ads synced custom audience IDs\",\n \"permissionLevel\": \"ANONYMOUS\",\n \"precision\": 0,\n \"profileCount\": 0,\n \"showInUI\": false,\n \"tags\": [\"Identifier\"],\n \"totalProfileCount\": 130300,\n \"useValidation\": true,\n \"values\": []\n }, {\n \"availableForSegmentation\" : true,\n \"canRead\" : true,\n \"canWrite\" : true,\n \"createNewProfile\" : false,\n \"creationDate\" : \"2023-03-20T13:53:35.046Z\",\n \"dataSensitivity\" : \"NON_PII\",\n \"description\" : \"Indicates whether an ad blocker was detected for the visitor. Will contain the value \\\\\"yes\\\\\" if one was detected.\",\n \"filterType\" : \"SELECT\",\n \"id\" : \"adblock_detected\",\n \"indexed\" : false,\n \"isIdProperty\" : false,\n \"lastModifiedDate\" : \"2023-03-22T09:34:55.568Z\",\n \"lastModifiedUser\" : {\n \"fullName\" : \"test@blueconic.com\",\n \"userName\" : \"test@blueconic.com\"\n },\n \"links\" : [ {\n \"href\" : \"https://localhost/rest/v2/profileProperties/adblock_detected?alt=application%2Fjson\",\n \"rel\" : \"self\",\n \"type\" : \"application/json\"\n } ],\n \"mergeStrategy\" : \"BOTH\",\n \"name\" : \"AdBlock usage detected\",\n \"permissionLevel\" : \"ANONYMOUS\",\n \"precision\" : 0,\n \"profileCount\" : 0,\n \"showInUI\" : true,\n \"tags\" : [ \"Address\", \"Process\" ],\n \"totalProfileCount\" : 130300,\n \"useValidation\" : true,\n \"values\" : [ ]\n }]\n}"
Response body (group properties):
description: Response body (group properties)
value: "{\n \"itemsPerPage\": 2,\n \"links\": {\n \"links\": [\n {\n \"href\": \"https://localhost/rest/v2/profileProperties?count=10\",\n \"rel\": \"alt\",\n \"type\": \"application/json\"\n }\n ]\n },\n \"profileProperties\": [\n {\n \"availableForSegmentation\": false,\n \"canRead\": true,\n \"canWrite\": true,\n \"compositionStrategy\": \"BOTH\",\n \"createNewProfile\": false,\n \"creationDate\": \"2025-09-26T12:27:24.442Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"dataSensitivity\": \"NON_PII\",\n \"description\": \"\",\n \"filterType\": \"SELECT\",\n \"groupTypeId\": \"company\",\n \"id\": \"company_location\",\n \"indexed\": false,\n \"isIdProperty\": false,\n \"lastModifiedDate\": \"2025-09-26T12:27:24.442Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"links\": [\n {\n \"href\": \"https://localhost/rest/v2/profileProperties/company_faddfafda?alt=application%2Fjson\",\n \"rel\": \"self\",\n \"type\": \"application/json\"\n }\n ],\n \"mergeStrategy\": \"BOTH\",\n \"name\": \"Company location\",\n \"permissionLevel\": \"ANONYMOUS\",\n \"precision\": 0,\n \"profileCount\": 0,\n \"showInUI\": true,\n \"tags\": [],\n \"totalProfileCount\": 1,\n \"useValidation\": true,\n \"values\": []\n },\n {\n \"availableForSegmentation\": false,\n \"canRead\": true,\n \"canWrite\": true,\n \"compositionStrategy\": \"BOTH\",\n \"createNewProfile\": false,\n \"creationDate\": \"2025-09-25T11:51:34.249Z\",\n \"creator\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"dataSensitivity\": \"NON_PII\",\n \"description\": \"\",\n \"filterType\": \"SELECT\",\n \"groupTypeId\": \"company\",\n \"id\": \"company_name\",\n \"indexed\": false,\n \"isIdProperty\": false,\n \"lastModifiedDate\": \"2025-09-25T11:51:34.249Z\",\n \"lastModifiedUser\": {\n \"fullName\": \"ondemand@blueconic.com\",\n \"userName\": \"ondemand@blueconic.com\"\n },\n \"links\": [\n {\n \"href\": \"https://localhost/rest/v2/profileProperties/company_name?alt=application%2Fjson\",\n \"rel\": \"self\",\n \"type\": \"application/json\"\n }\n ],\n \"mergeStrategy\": \"BOTH\",\n \"name\": \"Company name\",\n \"permissionLevel\": \"ANONYMOUS\",\n \"precision\": 0,\n \"profileCount\": 0,\n \"showInUI\": true,\n \"tags\": [],\n \"totalProfileCount\": 1,\n \"useValidation\": true,\n \"values\": []\n }\n ],\n \"startIndex\": 0,\n \"totalPages\": 1,\n \"totalResults\": 2\n}"
'401':
description: Authentication failed (unauthorized).
'503':
description: The server is too busy to handle the request.
security:
- oauth2:
- read:profile-properties
components:
schemas:
profileProperty:
type: object
properties:
availableForSegmentation:
type: boolean
default: false
description: Whether the property is available as a filter to create segments.
canRead:
type: boolean
default: false
description: Whether the visitor's browser is allowed to retrieve the value for this property.
canWrite:
type: boolean
default: false
description: Whether the visitor's browser is allowed to write a (new) value into this property.
createNewProfile:
type: boolean
default: false
description: Whether a visitor will switch to a new profile when a new value for the profile property is set. This will prevent potential profile hijacking. Only applicable when "indexed" is "true." This is only relevant for profile properties, not group 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'
currency:
$ref: '#/components/schemas/currency'
dataSensitivity:
type: string
default: NON_PII
description: The data sensitivity for the property.
enum:
- NON_PII
- PII
description:
type: string
description: The description.
filterType:
type: string
default: None
description: The filtertype of the property. Note that changing the type might lead to loss of information.
enum:
- RANGE
- CURRENCY
- DECIMAL
- SELECT
- EMAIL
- DATETIME
filterTypeSuggestion:
type: string
description: The suggested filter type.
readOnly: true
groupTypeId:
type: string
description: The ID of the group type that this property belongs to. Blank for profile properties.
id:
type: string
description: The object ID.
indexed:
type: boolean
default: false
description: Specifies that the profile property holds a unique value for each profile. When enabled, the property is indexed and used as a unique identifier.
isIdProperty:
type: boolean
description: Whether this is a property that contains references to groups (only relevant to profile properties of type 'Group ID').
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'
lastProfileMutationDate:
type: string
format: date-time
description: The last time a profile has been updated.
readOnly: true
linkingGroupTypeId:
type: string
description: The ID of the group type that this profile property contains the group references for (only applicable to profile properties).
example: household
mergeStrategy:
type: string
default: None
description: The merge strategy of the property.
enum:
- BOTH
- SUM
- HIGHEST
- LOWEST
- LATEST
- OLDEST
- KEEP_CURRENT
- SYSTEM_DEFINED
name:
type: string
description: The object name.
permissionLevel:
type: string
default: ANONYMOUS
description: The permission level of the property.
enum:
- DO_NOT_TRACK
- ANONYMOUS
- PERSONAL
precision:
type: integer
format: int32
default: 0
description: The precision of a property, e.g. 3. Only applicable when the “filterType” is "DECIMAL."
example: 3
profileCount:
type: integer
format: int64
description: Number of profiles that have a value for this property.
readOnly: true
range:
$ref: '#/components/schemas/range'
showInUI:
type: boolean
default: true
description: Whether the property is shown in the segments UI. Only applicable when "isAvailableForSegmentation" is "true."
tags:
type: array
description: The tags (i.e. labels).
example: Address
items:
type: string
description: The tags (i.e. labels).
example: Address
totalProfileCount:
type: integer
format: int64
description: The total number of profiles that have a value for this property.
readOnly: true
unit:
$ref: '#/components/schemas/unit'
useValidation:
type: boolean
default: false
description: Whether the value should be validated according to the validation rules of the filter type.
values:
type: array
description: When selecting this property as filter for segmentation, these values will be selectable next to the values that are in the profiles. Only applicable when "availableForSegmentation" is "true".
items:
type: string
description: When selecting this property as filter for segmentation, these values will be selectable next to the values that are in the profiles. Only applicable when "availableForSegmentation" is "true".
uniqueItems: true
label:
type: object
description: The labels for the name
properties:
content:
type: string
description: The label value
locale:
type: string
description: The label locale
currency:
type: object
default: None
description: The currency.
example: EUR
properties:
isoCode:
type: string
description: The currency ISO code, e.g. "USD". Only applicable when the filterType is "CURRENCY."
example: EUR, USD, etc.
name:
type: string
description: The currency name, e.g. "US Dollar", "Euro", etc.
readOnly: true
precision:
type: integer
format: int32
description: The number of decimal places used by the currency.
readOnly: true
symbol:
type: string
description: The currency symbol, e.g. "$", "€", etc.
readOnly: true
link:
type: object
properties:
Href:
type: string
description: The href of the link
Rel:
type: string
description: The link rel e.g. 'self', 'next', etc.
Type:
type: string
description: The type of the link e.g. 'application/json'
Labels:
type: object
description: The language labels for the unit.
properties:
label:
type: array
description: The labels for the name
items:
$ref: '#/components/schemas/label'
range:
type: object
description: The interval set for the property
properties:
max:
type: integer
format: int64
description: The maximum value of the range
min:
type: integer
format: int64
description: The minimum value of the range
readOnly: true
profileProperties:
type: object
properties:
itemsPerPage:
type: integer
format: int32
description: Number of results per page.
readOnly: true
links:
$ref: '#/components/schemas/links'
profileProperties:
type: array
items:
$ref: '#/components/schemas/profileProperty'
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
unit:
type: object
description: The unit of the property.
properties:
id:
type: string
description: The unit ID.
name:
$ref: '#/components/schemas/Labels'
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
links:
type: object
properties:
links:
type: array
description: The related links.
items:
$ref: '#/components/schemas/link'
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