Skip to main content

Wallboard API Documentation (1.11)

Download OpenAPI specification:Download

API Support: support@wallboard.us

OpenAPI specification (OAS) for the Wallboard API.

Wallboard has hundreds of endpoints and documenting all of them takes time. If you have any question please contact our support and we'll extend the documentation on-demand, based on your needs.

Overview

In this document, you can find some useful information about the Wallboard API. The API mainly follows the REST approach with OAuth 2.0 authentication and authorization standards.

Wallboard have two types of end-points:

Public

  • Callable by any client
  • API root starts with /public-api/
  • No OAuth2 authorization
  • Usually used with GUID based ID-s

Secured

  • Only callable with OAuth2 authorization
  • API root starts with /api/

Notes

  • The API only uses JSON format for data transfer objects.
  • The update logic usually follows the “if an attribute is null, it’s ignored” logic.
  • In the return value if an attribute is not present it means NULL (to lower the overall traffic).

Generally available parameters

customerId - tenant selector parameter

  • Customer ID parameter is present on most our endpoints and it can be used to select a specific tenant in the system, which the operations should be performed on.
  • This is used by ADMIN users (or network/subresellers OWNERS) as they have access to multiple tenants.
  • Non-admin users don't have to fill this parameter, because they can only access their customer's resources.
  • If as an ADMIN you want to get every resource in the system set this value to "-1".

page,size - pagination parameters

  • Pagination is implemented by the default Spring pagination logic.
  • Page index starts from 0.
  • If you don’t set any additional parameter, the API gives back the first 20 elements.
  • The maximum element count for a page is 1000.

sort parameter

  • Spring's default sort expression
  • Directions: asc, desc
  • Multiple parameters are supported - sort=name,asc&sort=lastActivity,desc
  • There is no escape logic, the parameter simply has to be URL encoded.
  • Value selectors can be chained with a . to be able to access embedded or connected entities' attributes
  • Examples: sort=name,asc, sort=content.name,asc

search - filtering parameter

With this parameter you can create dynamic queries to filter the resources.

select - selecting fields

With this parameter you can specify which attributes or related entities should be present in the response.

Syntax (WBQL - Wallboard Query Language)

Search (WBCriteria)

Value operators

  • : - means contains in case of string literals and equals in case of other value types
    • Example: name:mydevice - matches for prefix-mydevice-postfix
  • = - means exact match
  • - not equals
    • Unicode escape sequence: \u2260
  • - not contains
    • Works only with string literals
    • Unicode escape sequence: \u2209
  • ^ - starts with
    • Works only with string literals
  • > - greater than
  • - greater than or equal
    • Unicode escape sequence: \2265
  • < - less than
  • - less than or equal
    • Unicode escape sequence: \2264

Logical operators

  • , - AND
    • Example: name=a,name=b
  • | - OR
    • Example: name=something|name=something else
  • Logical groupings are currently not supported

Value matcher keywords

  • true
    • Only can be used with boolean attributes
    • Example: isValid:true
  • false
    • Only can be used with boolean attributes
  • NULL - value or connected entity is null
    • Example: content=NULL
  • !NULL - value or connected entity is NOT null
    • Example: folder.parent=!NULL

Escaping

  • All values has to be URL encoded
  • The search parameter value must be URL encoded (most libraries encode request parameters by default)
  • Format: search=urlEncode({value_name}{value_operator}urlEncode({value}))
  • Example: search=name:mydevice:athome (the second : is part of the device's name) -> search=name%3Amydevice%253Aathome
  • Example: search=teamAssignments.team.id=teamId1|teamAssignments.team.id=teamId2

Notes

  • Date type attributes are supported and can be matched by UTC timestamps (milliseconds)
    • Example: startDate>1683616562 - means the startDate should be after 2023-05-09T07:15:46+00:00
  • Value selectors can be chained with a . to be able to access embedded or connected entities' attributes
    • Example: deviceGroup.parent.id=000c08d294df48efb1b0f5aa754d7ef9 - meaning: the device's group's parent group's id should be '000c08d294df48efb1b0f5aa754d7ef9'.

Basic Examples

  • User name contains the letter a: name:a
  • Device state is online and is in emergency state: state:ONLINE,device.emergencyStatus:true
  • A device content's name contains the substring "happy new year": content.name:happy new year

Advanced Examples

  • Coming soon

Select (WBSelect)

With the select parameter you can also specify attributes that you want to select from a given entity. This method allows you to run more optimal and faster queries.

You can use the select function to append attributes from other related entities to the query (if the relationship is one-to-one or many-to-one).

Syntax:

  • * : Selects all primitive attributes of the entity
    • Equivalent to the missing select parameter
    • Calculated fields and related entities are NOT included
    • Example: select=*
  • , : Attributes should be separated with a ,
    • Example: select=id,name,comment
  • ( ) : Used to select specific attributes from related entities
    • Example: select=id,name,device(id,name)

Advanced examples:

  • select=*,customer(id,name)
    • Selects all primitive attributes from the device, plus the id and name of the customer it belongs to
  • select=*,totalUserLoginCount,lastDeviceActivity
    • Select all the primitive attributes from the customer and the two specified calculated fields

Team management

includeReadOnlyInfo parameter

  • Most of the GET endpoints support the optional calculation of the readOnly-ness of a resource
  • An entity can be read-only for a user depending on the team settings
  • If specifically not needed we suggest to turn if off, for faster response times

includeResourcesWithoutTeam parameter

  • Determines whether or not to include resources which are not assigned to any team

selectTeamIds parameter

  • A list of team ids that resources should be included in the response
  • If empty, all team's resources are included
  • Example: selectTeamIds=teamId1,teamId2

Roles

All users have a role and all of the secured API requires a minimum role to use it. The role is always hierarchical, so a user with an OWNER role can use all endpoints that require an OWNER or lower roles. We use the following hierarchy:

Global:

  • ADMIN
    • Super admin of the system.
    • Can access anything and can do everything.

Tenant:

  • OWNER
    • Tenant(customer) admin.
    • Under it's own domain can access anything and can do everything.
    • Can't belong to any team.
  • TECHNICIAN
    • Can do everything except user and team management.
  • APPROVER
  • EDITOR
  • CONTRIBUTOR
  • VIEWER

Terminology

We are using a bit different terminology for entities like you used to in our GUI. The following expressions mean the same:

  • device = screen = player
  • customer = client = tenant
  • subreseller = network owner

Swagger - Deprecated

We have swagger set up at https://development.wallboard.info/swagger-ui.html, but it's not perfectly configured, there can be missing or misleading parameters. Also, the microservice's API is missing from there.

Authentication

OAuth2 client credentials

By default, there are two built-in client credentials in the system, which you can use to get an access_token.

Default client details:

  • client-id: default-client
  • client-secret: 76211db5d8ea
  • Basic auth header value: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh
  • access_token validity: 20 minutes
  • refresh_token validity: 30 days

Short-lived client details:

  • client-id: short-lived
  • client-secret: mPSjfsJy8rs4m7y4
  • Basic auth header value: Basic c2hvcnQtbGl2ZWQ6bVBTamZzSnk4cnM0bTd5NA==
  • access_token validity: 20 minutes
  • refresh_token validity: 30 minutes

JWT

Certain new API endpoints use JWT token as authorization instead of the regular access_token.

token

OAuth2 token management operations

Get and refresh access token

To log in (get first access_token) fill username/password and set grant_type to "password".

To exchange a refresh_token for a new access_token fill refresh_token parameter and set grant_type to "refresh_token".

header Parameters
Authorization
required
string <Basic clientId:clientSecret>
Example: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh

Uses basic authentication. The 'clientId:clientSecret' part must be base64 encoded.

Request Body schema: x-www-form-urlencoded
required
username
string <username@example.com>

Email address of the user who wants to log in.

password
string

Password of the user who wants to log in.

refresh_token
string

Refresh token of the user who already logged in.

grant_type
string
Enum: "password" "refresh_token"

On login use "password", on refresh use "refresh_token".

Responses

Request samples

curl -X POST \
  https://example.com/oauth/token \
  -H 'Authorization: Basic ZGVmYXVsdC1jbGllbnQ6NzYyMTFkYjVkOGVh' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=password' \
  --data-urlencode 'username=user@example.com' \
  --data-urlencode 'password=MyPassword123'

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "bearer",
  • "expires_in": 0,
  • "refresh_token": "string",
  • "refresh_total_validity_seconds": 0,
  • "jwt_access_token": "string",
  • "customer_id": 0
}

customer

Customer management

Promote customer as subreseller

This endpoint is used to promote customer as subreseller customer.

path Parameters
customerId
required
integer

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/customer/182/promoteAsSubreseller'

Response samples

Content type
application/json
{
  • "id": 0
}

Remove subreseller privilege from customer

This endpoint is used to remove subreseller privilege from customer.

path Parameters
customerId
required
integer

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/customer/182/removeSubresellerPrivilege'

Create customer

This endpoint is used to create customer.

Request Body schema: application/json
required
id
integer
comment
string
country
string
expirationDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
freeLicenses
integer
browserSessionLicenses
integer
deviceSessionLimit
integer
licenseType
string (licenseType)
Enum: "BASIC" "PROFESSIONAL" "ENTERPRISE" "DBA"
profile
string (customerProfile)
Enum: "BASIC" "ADVANCED" "PROFESSIONAL" "INHERIT"
location
string
name
string
restricted
boolean
type
string
contentDesignerEmail
string
supportEmail
string
createdDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
needToBeInvoiced
boolean
storageSize
integer
vertical
string (customerVertical)
Enum: "BANKING_AND_FINANCE" "EMPLOYEE_CORPORATE_COMMUNICATION" "CORPORATE_MEETING_ROOMS" "DIGITAL_SIGNAGE" "EDUCATION_COLLAGE_AND_UNIVERSITIES" "CONFERENCE_AND_CONVENTION_CENTERS" "GOVERNMENT" "HEALTHCARE" "HOSPITALITY" "QUICK_SERVICE_RESTAURANT" "RETAIL" "SPORTS" "PETROL_STATIONS" "TRANSPORTATION" "ENTERTAINMENT" "WAYFINDING_AND_DIRECTORIES" "OTHER"
hiddenUIElementRules
string
enableAutomaticDistributionToDms
boolean
userFullAccessIfNotInTeam
boolean
accessResourcesWithoutTeam
boolean
object (brandingGuideline)
object (subreseller)
ownerSubresellerId
integer
slaveId
string
onlineLicenses
integer
totalLicenses
integer
usedFree
integer
activeLicenses
integer
deviceAndGroupCreationEnabledInRootForTeamUsers
boolean
contentAndGroupCreationEnabledInRootForTeamUsers
boolean
fileAndFolderCreationEnabledInRootForTeamUsers
boolean
ownerName
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE",
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "brandingGuideline": {
    },
  • "subreseller": {
    },
  • "ownerSubresellerId": 0,
  • "slaveId": "string",
  • "onlineLicenses": 0,
  • "totalLicenses": 0,
  • "usedFree": 0,
  • "activeLicenses": 0,
  • "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "contentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "fileAndFolderCreationEnabledInRootForTeamUsers": true,
  • "ownerName": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE",
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "brandingGuideline": {
    },
  • "subreseller": {
    },
  • "ownerSubresellerId": 0,
  • "slaveId": "string",
  • "onlineLicenses": 0,
  • "totalLicenses": 0,
  • "usedFree": 0,
  • "activeLicenses": 0,
  • "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "contentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "fileAndFolderCreationEnabledInRootForTeamUsers": true,
  • "ownerName": "string"
}

Get customers

This endpoint is used to retrieve customer data.

query Parameters
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

select
string (select)

WBQL select expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/?page=0&size=10'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get customer info

This endpoint is used to retrieve customer info data.

query Parameters
customerId
integer (customerId)

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/info'

Response samples

Content type
application/json
{
  • "id": 0,
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE",
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "brandingGuideline": {
    },
  • "subreseller": {
    },
  • "ownerSubresellerId": 0,
  • "slaveId": "string",
  • "onlineLicenses": 0,
  • "totalLicenses": 0,
  • "usedFree": 0,
  • "activeLicenses": 0,
  • "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "contentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "fileAndFolderCreationEnabledInRootForTeamUsers": true,
  • "ownerName": "string"
}

Get customer

This endpoint is used to retrieve customer data.

query Parameters
customerId
integer (customerId)

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/select?customerId=182'

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "subscriptionId": "string",
  • "user": {
    },
  • "subscriptionUrl": "string"
}

Get customers with basic attributes (simple)

This endpoint is useful for listing or if quick response time is required and you only need the id and name.

query Parameters
search
string (search)

WBQL search expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/simple'

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Get customers with basic attributes (simplePaged)

This endpoint is useful for listing or if quick response time is required and you only need the id and name.

query Parameters
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/simplePaged'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get customer statistics

This endpoint is used to retrieve customer statistics.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/stats'

Response samples

Content type
application/json
{
  • "additionalProp1": { },
  • "additionalProp2": { },
  • "additionalProp3": { }
}

Get customer statistics by id

This endpoint is used to retrieve customer statistics by customerId.

query Parameters
customerId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/182/stats'

Response samples

Content type
application/json
{
  • "totalDevices": 0,
  • "totalLicenses": 0,
  • "lastDeviceActivity": 1683802510,
  • "activeDevicesInLastWeek": 0,
  • "totalUsers": 0,
  • "totalUserPresenceTime": 0,
  • "totalUserLoginCount": 0,
  • "activeUsersInLastWeek": 0,
  • "totalContents": 0,
  • "totalDatasources": 0,
  • "ownedCustomerCount": 0,
  • "devicesByState": {
    },
  • "devicesByLicensePayType": {
    },
  • "devicesByLicenseType": {
    },
  • "contentsByType": {
    }
}

Get customer usage details

This endpoint is used to retrieve customer storage usage details.

query Parameters
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/usageDetails'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get customer white label properties

This endpoint is used to retrieve customer white label properties data.

query Parameters
customerId
integer (customerId)

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/customerWhiteLabelProperties?customerId=182'

Response samples

Content type
application/json
{
  • "domainName": "string"
}

Get subreseller customers

This endpoint is used to retrieve subreseller customer data.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/ownedAsSubreseller'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get customers csv

This endpoint is used to retrieve customer csv data.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/csv'

Get customer default content

This endpoint is used to retrieve customer default content data.

query Parameters
customerId
integer (customerId)
includeEmergencyContent
boolean

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/customer/settings/getDefaultContents?customerId=182&includeEmergencyContent=true'

Response samples

Content type
application/json
{
  • "emergencyContent": {
    }
}

Set customer default content

This endpoint is used to set default content for customer.

query Parameters
customerId
integer (customerId)
defaultEmergencyContentId
string

Responses

Request samples

curl -X PUT \
  '{{server_root}}/api/customer/settings/setDefaultContents?customerId=182&defaultEmergencyContentId=158309d3291041cb7e6887552076'

Set customer slave

This endpoint is used to set customer slave.

query Parameters
customerId
required
integer
slaveId
required
string

Responses

Request samples

curl -X PUT \
  '{{server_root}}/api/customer/settings/setSlave?customerId=182&slaveId=158309d3291041cb7e6887552076'

Update customer team settings

This endpoint is used to update customer global team settings data.

query Parameters
customerId
integer (customerId)
Request Body schema: application/json
required
userFullAccessIfNotInTeam
boolean
accessResourcesWithoutTeam
boolean
isDeviceAndGroupCreationEnabledInRootForTeamUsers
boolean
isContentAndGroupCreationEnabledInRootForTeamUsers
boolean
isFileAndFolderCreationEnabledInRootForTeamUsers
boolean

Responses

Request samples

Content type
application/json
{
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "isDeviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "isContentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "isFileAndFolderCreationEnabledInRootForTeamUsers": true
}

Update customer hidden UI element rules

This endpoint is used to update customer hidden UI element rules.

path Parameters
customerId
required
integer
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": 0,
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE",
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "brandingGuideline": {
    },
  • "subreseller": {
    },
  • "ownerSubresellerId": 0,
  • "slaveId": "string",
  • "onlineLicenses": 0,
  • "totalLicenses": 0,
  • "usedFree": 0,
  • "activeLicenses": 0,
  • "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "contentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "fileAndFolderCreationEnabledInRootForTeamUsers": true,
  • "ownerName": "string"
}

Update customer branding guideline

This endpoint is used to update customer branding guideline data.

query Parameters
customerId
integer (customerId)
Request Body schema: application/json
required
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "colors": [
    ],
  • "fonts": [
    ]
}

Move customer to subreseller

This endpoint is used to move customer under a subreseller customer.

path Parameters
customerId
required
integer
query Parameters
subresellerId
integer

Responses

Request samples

curl -X PUT \
  '{{server_root}}/api/customer/182/moveToSubreseller?subresellerId=145'

Update subreseller customer

This endpoint is used to update subreseller customer data.

path Parameters
subresellerId
required
integer
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0
}

Update customer

This endpoint is used to update customer data.

path Parameters
customerId
required
integer
Request Body schema: application/json
required
comment
string
country
string
expirationDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
freeLicenses
integer
licenseType
string (licenseType)
Enum: "BASIC" "PROFESSIONAL" "ENTERPRISE" "DBA"
profile
string (customerProfile)
Enum: "BASIC" "ADVANCED" "PROFESSIONAL" "INHERIT"
location
string
name
string
restricted
boolean
type
string
contentDesignerEmail
string
supportEmail
string
createdDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
needToBeInvoiced
boolean
hiddenUIElementRules
string
enableAutomaticDistributionToDms
boolean
browserSessionLicenses
integer
deviceSessionLimit
integer
storageSize
integer
vertical
string (customerVertical)
Enum: "BANKING_AND_FINANCE" "EMPLOYEE_CORPORATE_COMMUNICATION" "CORPORATE_MEETING_ROOMS" "DIGITAL_SIGNAGE" "EDUCATION_COLLAGE_AND_UNIVERSITIES" "CONFERENCE_AND_CONVENTION_CENTERS" "GOVERNMENT" "HEALTHCARE" "HOSPITALITY" "QUICK_SERVICE_RESTAURANT" "RETAIL" "SPORTS" "PETROL_STATIONS" "TRANSPORTATION" "ENTERTAINMENT" "WAYFINDING_AND_DIRECTORIES" "OTHER"

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "comment": "string",
  • "country": "string",
  • "expirationDate": 1683802510,
  • "freeLicenses": 0,
  • "browserSessionLicenses": 0,
  • "deviceSessionLimit": 0,
  • "licenseType": "BASIC",
  • "profile": "BASIC",
  • "location": "string",
  • "name": "string",
  • "restricted": true,
  • "type": "string",
  • "contentDesignerEmail": "string",
  • "supportEmail": "string",
  • "createdDate": 1683802510,
  • "needToBeInvoiced": true,
  • "storageSize": 0,
  • "vertical": "BANKING_AND_FINANCE",
  • "hiddenUIElementRules": "string",
  • "enableAutomaticDistributionToDms": true,
  • "userFullAccessIfNotInTeam": true,
  • "accessResourcesWithoutTeam": true,
  • "brandingGuideline": {
    },
  • "subreseller": {
    },
  • "ownerSubresellerId": 0,
  • "slaveId": "string",
  • "onlineLicenses": 0,
  • "totalLicenses": 0,
  • "usedFree": 0,
  • "activeLicenses": 0,
  • "deviceAndGroupCreationEnabledInRootForTeamUsers": true,
  • "contentAndGroupCreationEnabledInRootForTeamUsers": true,
  • "fileAndFolderCreationEnabledInRootForTeamUsers": true,
  • "ownerName": "string"
}

Delete customer

This endpoint is used to delete customer.

path Parameters
customerId
required
integer

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/customer/182'

user

User management

Reset user password

This endpoint is used to reset user password.

query Parameters
email
required
string

Responses

Request samples

curl -X POST \
  '{{server_root}}/public-api/user/forgotPassword?email=wallboard%40wallboard.info'

Update user password

This endpoint is used to update user password.

query Parameters
oldPassword
required
string
newPassword
required
string

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/user/password?oldPassword=oldPassword1&newPassword=newPassword1'

Update user pin code

This endpoint is used to update user pin code.

query Parameters
email
required
string
pinCode
string

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/user/pinCode?email=wallboard%40wallboard.info&pinCode=1234'

Accept terms of service

This endpoint is used to accept terms of service.

path Parameters
accepted
required
boolean

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/user/acceptTermsOfService/true'

Update user team assignments

This endpoint is used to update user team assignments.

query Parameters
customerId
integer (customerId)
email
required
string
Request Body schema: application/json
required
Array of objects
removeFromTeamIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "assignToTeams": [
    ],
  • "removeFromTeamIds": [
    ]
}

Send feedback

This endpoint is used to send feedback.

Request Body schema: application/json
required
Array of objects
message
string
messageType
string

Responses

Request samples

Content type
application/json
{
  • "images": [
    ],
  • "message": "string",
  • "messageType": "string"
}

Send content request

This endpoint is used to send content request.

Request Body schema: application/json
required
Array of objects
message
string
messageType
string
contentName
string
startDate
string
endDate
string
targetScreenGroup
string

Responses

Request samples

Content type
application/json
{
  • "images": [
    ],
  • "message": "string",
  • "messageType": "string",
  • "contentName": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "targetScreenGroup": "string"
}

Create user

This endpoint is used to create user.

query Parameters
customerId
integer (customerId)
Request Body schema: application/json
required
email
string
name
string
language
string
phoneNumber
string
address
string
comment
string
iconUrl
string
lastLogin
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
createdDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
termsOfServiceAcceptDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
logins
integer
presenceTime
integer
lastActivity
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
editorLevel
string (editorLevel)
Enum: "BASIC" "ADVANCED" "PROFESSIONAL"
role
string (userRole)
Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN"
authProvider
string (authProvider)
Enum: "LOCAL" "LDAP" "KEYCLOAK"
ssoLoginEnabled
boolean
usernamePasswordLoginEnabled
boolean
use2FA
boolean
restricted
boolean
hasProfilePicture
boolean
hiddenUIElementRules
string
object (customer)
customerId
integer
object (location)
object (userInterfaceProfile)
userInterfaceProfileId
integer
regionalFormatSettings
object
ownerCanAccessNetworkMember
boolean
storageIdentifier
string
resetUserInterfaceProfile
boolean
profilePictureApiPath
string
readOnly
boolean
active
boolean
pinCodePresent
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "language": "string",
  • "phoneNumber": "string",
  • "address": "string",
  • "comment": "string",
  • "iconUrl": "string",
  • "lastLogin": 1683802510,
  • "createdDate": 1683802510,
  • "termsOfServiceAcceptDate": 1683802510,
  • "logins": 0,
  • "presenceTime": 0,
  • "lastActivity": 1683802510,
  • "editorLevel": "BASIC",
  • "role": "DEVICE_USER",
  • "authProvider": "LOCAL",
  • "ssoLoginEnabled": true,
  • "usernamePasswordLoginEnabled": true,
  • "use2FA": true,
  • "restricted": true,
  • "hasProfilePicture": true,
  • "hiddenUIElementRules": "string",
  • "customer": {
    },
  • "customerId": 0,
  • "location": {
    },
  • "userInterfaceProfile": {
    },
  • "userInterfaceProfileId": 0,
  • "regionalFormatSettings": { },
  • "ownerCanAccessNetworkMember": true,
  • "storageIdentifier": "string",
  • "resetUserInterfaceProfile": true,
  • "profilePictureApiPath": "string",
  • "readOnly": true,
  • "active": true,
  • "pinCodePresent": true
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "language": "string",
  • "phoneNumber": "string",
  • "address": "string",
  • "comment": "string",
  • "iconUrl": "string",
  • "lastLogin": 1683802510,
  • "createdDate": 1683802510,
  • "termsOfServiceAcceptDate": 1683802510,
  • "logins": 0,
  • "presenceTime": 0,
  • "lastActivity": 1683802510,
  • "editorLevel": "BASIC",
  • "role": "DEVICE_USER",
  • "authProvider": "LOCAL",
  • "ssoLoginEnabled": true,
  • "usernamePasswordLoginEnabled": true,
  • "use2FA": true,
  • "restricted": true,
  • "hasProfilePicture": true,
  • "hiddenUIElementRules": "string",
  • "customer": {
    },
  • "customerId": 0,
  • "location": {
    },
  • "userInterfaceProfile": {
    },
  • "userInterfaceProfileId": 0,
  • "regionalFormatSettings": { },
  • "ownerCanAccessNetworkMember": true,
  • "storageIdentifier": "string",
  • "resetUserInterfaceProfile": true,
  • "profilePictureApiPath": "string",
  • "readOnly": true,
  • "active": true,
  • "pinCodePresent": true
}

Get users

This endpoint is used to retrieve user data.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/?customerId=182'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "content": [
    ]
}

Update user

This endpoint is used to update user data.

query Parameters
email
required
string
Request Body schema: application/json
required
email
string
name
string
language
string
phoneNumber
string
address
string
comment
string
iconUrl
string
lastLogin
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
createdDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
termsOfServiceAcceptDate
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
logins
integer
presenceTime
integer
lastActivity
integer <Epoch Unix timestamp in milliseconds.> (unix_timestamp)
editorLevel
string (editorLevel)
Enum: "BASIC" "ADVANCED" "PROFESSIONAL"
role
string (userRole)
Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN"
authProvider
string (authProvider)
Enum: "LOCAL" "LDAP" "KEYCLOAK"
ssoLoginEnabled
boolean
usernamePasswordLoginEnabled
boolean
use2FA
boolean
restricted
boolean
hasProfilePicture
boolean
hiddenUIElementRules
string
object (customer)
customerId
integer
object (location)
object (userInterfaceProfile)
userInterfaceProfileId
integer
regionalFormatSettings
object
ownerCanAccessNetworkMember
boolean
storageIdentifier
string
resetUserInterfaceProfile
boolean
profilePictureApiPath
string
readOnly
boolean
active
boolean
pinCodePresent
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "language": "string",
  • "phoneNumber": "string",
  • "address": "string",
  • "comment": "string",
  • "iconUrl": "string",
  • "lastLogin": 1683802510,
  • "createdDate": 1683802510,
  • "termsOfServiceAcceptDate": 1683802510,
  • "logins": 0,
  • "presenceTime": 0,
  • "lastActivity": 1683802510,
  • "editorLevel": "BASIC",
  • "role": "DEVICE_USER",
  • "authProvider": "LOCAL",
  • "ssoLoginEnabled": true,
  • "usernamePasswordLoginEnabled": true,
  • "use2FA": true,
  • "restricted": true,
  • "hasProfilePicture": true,
  • "hiddenUIElementRules": "string",
  • "customer": {
    },
  • "customerId": 0,
  • "location": {
    },
  • "userInterfaceProfile": {
    },
  • "userInterfaceProfileId": 0,
  • "regionalFormatSettings": { },
  • "ownerCanAccessNetworkMember": true,
  • "storageIdentifier": "string",
  • "resetUserInterfaceProfile": true,
  • "profilePictureApiPath": "string",
  • "readOnly": true,
  • "active": true,
  • "pinCodePresent": true
}

Delete user

This endpoint is used to delete user data.

query Parameters
email
required
string

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/user/?email=wallboard%40wallboard.info'

Delete own user account

This endpoint is used to delete own user account.

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/user/myAccount'

Delete user profile picture

This endpoint is used to delete user profile picture.

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/v2/user/profilePicture'

Add user profile picture

This endpoint is used to add user profile picture.

Responses

Request samples

curl -X POST \
  '{{server_root}}/api/v2/user/profilePicture'

Response samples

Content type
application/json
{
  • "picturePath": "string"
}

Get users V2

This endpoint is used to retrieve user data.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

select
string (select)

WBQL select expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/v2/user/??page=0&size=50&sort=lastActivity,desc&select=*,customer(*)'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "content": [
    ]
}

Get users with basic attributes (simple)

This endpoint is useful for listing or if quick response time is required and you only need the id and name.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/simple'

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Get users with basic attributes (simplePaged)

This endpoint is useful for listing or if quick response time is required and you only need the id and name.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/simplePaged'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get user terms of service acceptance info

This endpoint is used to retrieve terms of service acceptance info.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/userTermsOfServiceAcceptanceInfo'

Response samples

Content type
application/json
{
  • "userAcceptedTermsOfServiceDate": 1683802510,
  • "termsOfServiceLastUpdatedDate": 1683802510,
  • "userAcceptedLatestTermsOfService": true
}

Get user access and role

This endpoint is used to retrieve user access and role.

query Parameters
role
string (userRole)
Enum: "DEVICE_USER" "VIEWER" "EDITOR" "APPROVER" "TECHNICIAN" "OWNER" "ADMIN"
customerId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/checkAccessAndRole?role=TECHNICIAN&customerId=182'

Get google authentication URL

This endpoint is used to retrieve user google authentication QR code URL.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/googleAuthQrCodeUrl'

Response samples

Content type
application/json
{
  • "url": "string"
}

Get user statistics

This endpoint is used to retrieve user statistics.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/stats'

Response samples

Content type
application/json
{
  • "additionalProp1": { },
  • "additionalProp2": { },
  • "additionalProp3": { }
}

Get users csv

This endpoint is used to retrieve user csv data.

query Parameters
customerId
integer (customerId)

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/csv'

Ping user

This endpoint is used to ping.

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/user/ping'

user interface profile

User interface profile management

Update user interface profile assignments

This endpoint is used to update user interface profile user assignments.

path Parameters
userInterfaceProfileId
required
integer
Request Body schema: application/json
required
assignUserIds
Array of strings
removeUserIds
Array of strings
allIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "assignUserIds": [
    ],
  • "removeUserIds": [
    ],
  • "allIds": [
    ]
}

Create user interface profile

This endpoint is used to create user interface profile.

query Parameters
customerId
integer (customerId)
Request Body schema: application/json
required
hiddenUIElementRules
string
name
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "hiddenUIElementRules": "string",
  • "name": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string",
  • "customerId": 0
}

Get user interface profiles

This endpoint is used to retrieve user interface profile data.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

select
string (select)

WBQL select expression

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/v2/userInterfaceProfile?page=0&size=50&customerId=182'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Update user interface profile

This endpoint is used to update user interface profile.

path Parameters
userInterfaceProfileId
required
integer
Request Body schema: application/json
required
hiddenUIElementRules
string
name
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "hiddenUIElementRules": "string",
  • "name": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string",
  • "customerId": 0
}

Delete user interface profile

This endpoint is used to delete user interface profile.

path Parameters
userInterfaceProfileId
required
integer

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/v2/userInterfaceProfile/5'

team

Team management

Create team

query Parameters
customerId
integer (customerId)
Request Body schema: application/json
required
name
string
comment
string
hiddenUIElementRules
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string",
  • "teamUserNumber": 0,
  • "teamDeviceNumber": 0,
  • "teamDeviceGroupNumber": 0,
  • "teamDeviceContentNumber": 0,
  • "teamDatasourceNumber": 0,
  • "teamContentGroupNumber": 0,
  • "teamFileNumber": 0,
  • "teamFileFolderNumber": 0,
  • "teamMessageNumber": 0,
  • "teamMessageGroupNumber": 0,
  • "teamCampaignNumber": 0,
  • "teamMicrosoftTenantNumber": 0,
  • "teamGoogleCredentialNumber": 0,
  • "teamAdvertiserNumber": 0,
  • "teamNotificationChannelNumber": 0,
  • "teamAlertRuleNumber": 0,
  • "teamWebhookEventActionNumber": 0
}

Update team

query Parameters
teamId
required
string
Request Body schema: application/json
required
name
string
comment
string
hiddenUIElementRules
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string",
  • "teamUserNumber": 0,
  • "teamDeviceNumber": 0,
  • "teamDeviceGroupNumber": 0,
  • "teamDeviceContentNumber": 0,
  • "teamDatasourceNumber": 0,
  • "teamContentGroupNumber": 0,
  • "teamFileNumber": 0,
  • "teamFileFolderNumber": 0,
  • "teamMessageNumber": 0,
  • "teamMessageGroupNumber": 0,
  • "teamCampaignNumber": 0,
  • "teamMicrosoftTenantNumber": 0,
  • "teamGoogleCredentialNumber": 0,
  • "teamAdvertiserNumber": 0,
  • "teamNotificationChannelNumber": 0,
  • "teamAlertRuleNumber": 0,
  • "teamWebhookEventActionNumber": 0
}

Get teams

This endpoint is used to retrieve team data.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

page
integer (page)
Default: 0

Page index

size
integer (size)
Default: 20

Size of page

sort
string (sort)

Sort expression

includeTeamUserNumber
boolean
Default: false
includeTeamResourceNumber
boolean
Default: false

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/?customerId=182&includeTeamUserNumber=false&includeTeamResourceNumber=false'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": "string",
  • "content": [
    ]
}

Get team list

This endpoint is used to retrieve team data list.

query Parameters
customerId
integer (customerId)
search
string (search)

WBQL search expression

includeTeamUserNumber
boolean
Default: false
includeTeamResourceNumber
boolean
Default: false

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/list?customerId=182&includeTeamUserNumber=false&includeTeamResourceNumber=false'

Response samples

Content type
application/json
[
  • {
    }
]

Get team

This endpoint is used to retrieve team data by teamId.

path Parameters
teamId
required
string
query Parameters
includeTeamUserNumber
boolean
Default: false
includeTeamResourceNumber
boolean
Default: false

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/c0fe84f898534829816988949b6012c3?includeTeamUserNumber=false&includeTeamResourceNumber=false'

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "comment": "string",
  • "hiddenUIElementRules": "string",
  • "teamUserNumber": 0,
  • "teamDeviceNumber": 0,
  • "teamDeviceGroupNumber": 0,
  • "teamDeviceContentNumber": 0,
  • "teamDatasourceNumber": 0,
  • "teamContentGroupNumber": 0,
  • "teamFileNumber": 0,
  • "teamFileFolderNumber": 0,
  • "teamMessageNumber": 0,
  • "teamMessageGroupNumber": 0,
  • "teamCampaignNumber": 0,
  • "teamMicrosoftTenantNumber": 0,
  • "teamGoogleCredentialNumber": 0,
  • "teamAdvertiserNumber": 0,
  • "teamNotificationChannelNumber": 0,
  • "teamAlertRuleNumber": 0,
  • "teamWebhookEventActionNumber": 0
}

Delete team

This endpoint is used to delete team.

path Parameters
teamId
required
string

Responses

Request samples

curl -X DELETE \
  '{{server_root}}/api/team/a43424e4a87b4e53bd1217c72aa91c12'

Get team user assignments

This endpoint is used to retrieve team user assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/userAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get user team assignments

This endpoint is used to retrieve user team assignments data.

path Parameters
userEmail
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/user/wallboard%40wallboard.info/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team device assignments

This endpoint is used to retrieve team device assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get device team assignments

This endpoint is used to retrieve device team assignments data.

path Parameters
deviceId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/device/f229806904154d8abe67f42629d0c1bb/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team device group assignments

This endpoint is used to retrieve team device group assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get device group team assignments

This endpoint is used to retrieve device group team assignments data.

path Parameters
deviceGroupId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceGroup/7a6b26eea52549eda28c265acd808471/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team device content assignments

This endpoint is used to retrieve team device content assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceContentAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get device content team assignments

This endpoint is used to retrieve device content team assignments data.

path Parameters
deviceContentId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceContent/fvb50b6232b4eb19bce33c16c6db148/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team content group assignments

This endpoint is used to retrieve team content group assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/contentGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get content group team assignments

This endpoint is used to retrieve content group team assignments data.

path Parameters
contentGroupId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/contentGroup/7a6b26eea52549eda28c265acd808471/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team device install rule assignments

This endpoint is used to retrieve team device install rule assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceInstallRuleAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get device install rule team assignments

This endpoint is used to retrieve device install rule team assignments data.

path Parameters
deviceInstallRuleId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/deviceInstallRule/390/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team file assignments

This endpoint is used to retrieve team file assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/fileAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get file team assignments

This endpoint is used to retrieve file team assignments data.

path Parameters
fileId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/file/9d1db619f8364d5cb18c3853cb69c056/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team file folder assignments

This endpoint is used to retrieve team file folder assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/fileFolderAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get file folder team assignments

This endpoint is used to retrieve file folder team assignments data.

path Parameters
fileFolderId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/fileFolder/661d67c2829044228480eeb6/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team quick filter assignments

This endpoint is used to retrieve team quick filter assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/quickFilterAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get quick filter team assignments

This endpoint is used to retrieve quick filter team assignments data.

path Parameters
quickFilterId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/quickFilter/af0d948d59144d61a67e677b509dec49/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team datasource assignments

This endpoint is used to retrieve team datasource assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/datasourceAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get datasource team assignments

This endpoint is used to retrieve datasource team assignments data.

path Parameters
datasourceId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/datasource/477713a90f1846039aae43698c7d3aac/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team campaign assignments

This endpoint is used to retrieve team campaign assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/campaignAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get campaign team assignments

This endpoint is used to retrieve campaign team assignments data.

path Parameters
campaignId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/campaign/2328/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team advertiser assignments

This endpoint is used to retrieve team advertiser assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/advertiserAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get advertiser team assignments

This endpoint is used to retrieve advertiser team assignments data.

path Parameters
advertiserId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/advertiser/eab615518d4a405ea08f8002760c8739/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team message assignments

This endpoint is used to retrieve team message assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/messageAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get message team assignments

This endpoint is used to retrieve message team assignments data.

path Parameters
messageId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/message/881/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team message group assignments

This endpoint is used to retrieve team message group assignments data.

query Parameters
teamId
required
string

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/messageGroupAssignments?teamId=c0fe84f898534829816988949b6012c3'

Response samples

Content type
application/json
[
  • {
    }
]

Get message group team assignments

This endpoint is used to retrieve message group team assignments data.

path Parameters
messageGroupId
required
integer

Responses

Request samples

curl -X GET \
  '{{server_root}}/api/team/messageGroup/1264/assignments'

Response samples

Content type
application/json
[
  • {
    }
]

Get team alert rule assignments

This endpoint is used to retrieve team alert rule assignments data.

query Parameters
teamId
required
string

Responses