Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Engagedly Departments API

Create and manage organizational departments

Engagedly Departments API is one of 8 APIs that Engagedly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Departments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version beta.

Requests are made against a single base URL, https://api.engagedly.com/beta.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
beta
Base URL
https://api.engagedly.com/beta/
Authentication
API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 2

Engagedly Departments API declares 2 security schemes for authenticating requests. An API key is passed in the header as ClientKey (clientKeyAuth). An API key is passed in the header as SecretKey (secretKeyAuth). By default, every request must be authenticated.

  • clientKeyAuth — Client key obtained from the Engagedly portal under Integrations Engagedly API
  • secretKeyAuth — Secret key obtained from the Engagedly portal. Shown only once upon generation.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Departments 5

Create and manage organizational departments

GET
/departments
List all departments
listDepartments 2 params → 200401
POST
/departments
Create a new department
createDepartment body → 201400401422
GET
/departments/{id}
Get a single department
getDepartment 1 param → 200401404
PUT
/departments/{id}
Update an existing department
updateDepartment 1 param body → 200401404
DELETE
/departments/{id}
Delete a department
deleteDepartment 1 param → 204401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserRef (8 properties), Department (5 properties), DisplayPicture (5 properties), Pagination (4 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
3 properties
ErrorResponse
object
2 properties
DepartmentRequest
object
2 properties 1 required
DepartmentSingleResponse
object
2 properties
Department
object
5 properties
Pagination
object
4 properties
DepartmentListResponse
object
3 properties
UserRef
object
8 properties
DisplayPicture
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagedly-departments-api-openapi.yml Raw ↑

Other APIs Engagedly publishes across the network.

Engagedly Activities API
Engagedly Businesses API
Engagedly Job Titles API
Engagedly Locations API
Engagedly Permissions API
Engagedly User Attributes API
Engagedly Users API