Powered by Redocly

Employees

Employees are the people that have access to your Partner Portal.

Employee

Employees are the people that have access to your Partner Portal.

id
string <uuid>

Employee identifier.

enabled
boolean

Whether the employee is enabled.

family_name
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
string [ 1 .. 255 ] characters

Given name of the employee.

is_operator
boolean

Whether the employee can be assigned to a ticket as operator.

role
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "admin",
  • "username": "john.doe@my-partner.com"
}

Retrieve all employees

Retrieve a list of employees.

SecurityOAuth2 and ApiKey
Request
query Parameters
enabled
boolean

Filter employees by enabled status.

is_operator
boolean

Filter employees by is_operator status.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

username
string

Filter employees by username.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Employee) >= 0 items

List of employees.

Array (>= 0 items)
id
string <uuid>

Employee identifier.

enabled
boolean

Whether the employee is enabled.

family_name
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
string [ 1 .. 255 ] characters

Given name of the employee.

is_operator
boolean

Whether the employee can be assigned to a ticket as operator.

role
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/providers/employees
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Add an employee

Add a new employee.

SecurityApiKey and OAuth2
Request
Request Body schema: application/json
required

The employee you wish to add.

family_name
required
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
required
string [ 1 .. 255 ] characters

Given name of the employee.

role
required
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
required
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

Responses
201

Created.

Response Schema: application/json
id
string <uuid>

Employee identifier.

enabled
boolean

Whether the employee is enabled.

family_name
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
string [ 1 .. 255 ] characters

Given name of the employee.

is_operator
boolean

Whether the employee can be assigned to a ticket as operator.

role
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

400

Bad request.

default

An error occurred - see status code and problem response for more information.

post/v2/providers/employees
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "employee",
  • "username": "john.doe@my-partner.com"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "admin",
  • "username": "john.doe@my-partner.com"
}

Retrieve an employee

Retrieve an employee by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
employee-id
required
string <uuid>

Employee identifier.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Employee identifier.

enabled
boolean

Whether the employee is enabled.

family_name
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
string [ 1 .. 255 ] characters

Given name of the employee.

is_operator
boolean

Whether the employee can be assigned to a ticket as operator.

role
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

default

An error occurred - see status code and problem response for more information.

get/v2/providers/employees/{employee-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "admin",
  • "username": "john.doe@my-partner.com"
}

Update an employee

Update an employee by its identifier.

SecurityApiKey and OAuth2
Request
path Parameters
employee-id
required
string <uuid>

Employee identifier.

Request Body schema: application/json
required

The updated employee.

enabled
required
boolean

Whether the employee is enabled.

family_name
required
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
required
string [ 1 .. 255 ] characters

Given name of the employee.

role
required
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
required
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Employee identifier.

enabled
boolean

Whether the employee is enabled.

family_name
string [ 1 .. 255 ] characters

Family name of the employee.

given_name
string [ 1 .. 255 ] characters

Given name of the employee.

is_operator
boolean

Whether the employee can be assigned to a ticket as operator.

role
string

The role this employee has within your Partner portal.

Enum Value Description
employee

An employee in this role can manage your Partner Portal, with the exception of adding or changing employees. They can also view tickets, but not participate in its workflow as operator.

operator

Employees in the operator role are able to view and join tickets as operators, but are not able to access any configuration in your Partner Portal.

senior_operator

Senior Operators are able to participate in the workflow of a ticket and have access to configuration-pages of your Partner Portal, with the exception of adding or changing employees.

admin

Admins have full access to your Partner Portal; they have access to all Partner Portal configuration and are able to view and join tickets as operators.

username
string <email> <= 255 characters

Username of the employee. This should be a valid e-mail address.

400

Bad request.

default

An error occurred - see status code and problem response for more information.

put/v2/providers/employees/{employee-id}
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "employee",
  • "username": "john.doe@my-partner.com"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "family_name": "Doe",
  • "given_name": "John",
  • "is_operator": true,
  • "role": "admin",
  • "username": "john.doe@my-partner.com"
}
➔ Next to Branding profiles