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

Access praise and recognition activities

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

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

This API exposes 1 operation across 1 path, and defines 10 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.

1 operations 1 paths 10 schemas 1 GET

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 Activities 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Activities 1

Access praise and recognition activities

GET
/activities/praises
Get all public praises
listPublicPraises 2 params → 200401

Schemas 10

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

PraiseAudience
object
4 properties
PraiseTag
object
2 properties
PraiseActor
object
4 properties
Praise
object
17 properties
PraiseListResponse
object
3 properties
PraiseAuthor
object
4 properties
ErrorResponse
object
2 properties
ErrorDetail
object
3 properties
Pagination
object
4 properties
DisplayPicture
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagedly-activities-api-openapi.yml Raw ↑

Other APIs Engagedly publishes across the network.

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