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 Job Titles API

Define and manage job roles

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

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

This API exposes 5 operations across 2 paths, and defines 7 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 7 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 Job Titles 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.

Job Titles 5

Define and manage job roles

GET
/job_titles
List all job titles
listJobTitles 2 params → 200401
POST
/job_titles
Create a new job title
createJobTitle body → 201400401
GET
/job_titles/{id}
Get a single job title
getJobTitle 1 param → 200401404
PUT
/job_titles/{id}
Update an existing job title
updateJobTitle 1 param body → 200401404
DELETE
/job_titles/{id}
Delete a job title
deleteJobTitle 1 param → 204401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Pagination (4 properties), JobTitle (4 properties), ErrorDetail (3 properties), JobTitleListResponse (3 properties). Each schema is shown below with its type and property counts.

JobTitleSingleResponse
object
2 properties
JobTitleRequest
object
3 properties 1 required
JobTitle
object
4 properties
JobTitleListResponse
object
3 properties
ErrorResponse
object
2 properties
ErrorDetail
object
3 properties
Pagination
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagedly-job-titles-api-openapi.yml Raw ↑

Other APIs Engagedly publishes across the network.

Engagedly Activities API
Engagedly Businesses API
Engagedly Departments API
Engagedly Locations API
Engagedly Permissions API
Engagedly User Attributes API
Engagedly Users API