This API allows clients to read and write departments to Perform & Engage 365.
Throughout the API an 'api_id' is used. This can be specified by the client when creating a new department via the API, if one is not specified during creation or a user is created via a different method (i.e. the user interface) then the API ID can be obtained by querying the API.
Users can be created and managed using the Directory API: Users endpoints.
GET /departments/
List all employees in this organisation.
Parameters
| search: string | A search tem |
| limit: integer | Number of results to return per page |
| offset: integer |
The initial index from which to return results |
Response
Returns an object including a list of Departments.
{
count: integer,
next: string (uri),
previous: string (uri),
results: [
{
api_id: string,
name: string,
}
]
}
POST /departments/
Add a new department to this Perform & Engage 365 organisation.
Parameters
None
Request Body
{
api_id: string,
name: string,
}
Response
Returns an object including a list of Departments.
{
api_id: string,
name: string,
}
GET /departments/{ api_id }/
Get information for one department in this organisation.
Parameters
None
Response
Returns an object for this specific user.
{
api_id: string,
name: string,
}
PUT:PATCH /departments/{ api_id }/
Update or partially update a department's details.
Parameters
None
Request Body
{
api_id: string,
name: string
}
Response
Returns an object with the updated user's details.
{
api_id: string,
name: string
}
DELETE /departments/{ api_id }/
Delete a department's record from the organisation.
Parameters
None
Request
None
Response
None