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 Locations API

Manage office locations and addresses

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

Tagged areas include Locations. 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 Locations 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.

Locations 5

Manage office locations and addresses

GET
/locations
List all locations
listLocations 2 params → 200401
POST
/locations
Create a new location
createLocation body → 201400401
GET
/locations/{id}
Get a single location
getLocation 1 param → 200401404
PUT
/locations/{id}
Update an existing location
updateLocation 1 param body → 200401404
DELETE
/locations/{id}
Delete a location
deleteLocation 1 param → 204401404

Schemas 7

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

LocationListResponse
object
3 properties
Location
object
8 properties
LocationRequest
object
7 properties 1 required
LocationSingleResponse
object
2 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-locations-api-openapi.yml Raw ↑

Other APIs Engagedly publishes across the network.

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