Reelyze Developer API

Departments

Endpoint:https://developer-api.reelyze.com

Manage departments within an organisation. Departments are used to mirror your organisation structure and are used for targeting content and reporting.

Query Departments

GET

https://developer-api.reelyze.com

/v2/departments

Query all departments within your Reelyze tenant. Can be filtered by any property using querystring parameters

Query Departments › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Departments › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Query Departments for Organisation

GET

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments

Returns a list of all departments within the specified organisation

Query Departments for Organisation › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Departments for Organisation › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Create Department

POST

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments

Create a new department within the given organisation

Create Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Department › Request Body

Create Department › Responses

Created

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Get Department

GET

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Get details for a department

Get Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Department › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Update Department

PUT

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Update Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Department › Request Body

Update Department › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Delete Department

DELETE

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Delete Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete Department › Responses

No Content

No data returned

Organisations

Query Departments

GET

https://developer-api.reelyze.com

/v2/departments

Query all departments within your Reelyze tenant. Can be filtered by any property using querystring parameters

Query Departments › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Departments › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Query Departments for Organisation

GET

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments

Returns a list of all departments within the specified organisation

Query Departments for Organisation › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Departments for Organisation › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Create Department

POST

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments

Create a new department within the given organisation

Create Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Department › Request Body

Create Department › Responses

Created

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Get Department

GET

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Get details for a department

Get Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Department › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Update Department

PUT

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Update Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Department › Request Body

Update Department › Responses

idstring · required
organisationIdstring · required
namestring · required
Name of the department. Must be unique within the organisation.
parentIdstring | null · required
Id of the parent department.

Delete Department

DELETE

https://developer-api.reelyze.com

/v2/organisations/{organisationId}/departments/{departmentId}

Delete Department › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete Department › Responses

No Content

No data returned