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

Manage user profiles, permissions, and activation status

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

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

This API exposes 11 operations across 7 paths, and defines 15 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.

11 operations 7 paths 15 schemas 4 GET1 PATCH1 POST5 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 Users 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 11

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

Users 11

Manage user profiles, permissions, and activation status

GET
/users
List all users
listUsers 4 params → 200401
POST
/users
Create a new user
createUser body → 201400401422
GET
/users/block-reason-codes
Get block reason codes
listBlockReasonCodes → 200401
GET
/users/{id}
Get a single user
getUser 2 params → 200401404
PUT
/users/{id}
Update an existing user
updateUser 1 param body → 200400401404422
PATCH
/users/{id}
Partially update an existing user
partialUpdateUser 1 param body → 200400401404422
PUT
/users/{id}/profile/picture
Update user's profile picture
updateUserProfilePicture 1 param body → 200401404
PUT
/users/{id}/deactivate
Deactivate a user
deactivateUser 1 param body → 200401404
PUT
/users/{id}/activate
Activate a user
activateUser 1 param → 200401404
GET
/users/{id}/permissions
Get permissions of a user
getUserPermissions 1 param → 200401404
PUT
/users/{id}/permissions
Update permissions of a user
updateUserPermissions 1 param body → 200401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are User (28 properties), UserUpdateRequest (20 properties), UserCreateRequest (20 properties), UserRef (8 properties). Each schema is shown below with its type and property counts.

BlockReasonCodeListResponse
object
2 properties
ErrorDetail
object
3 properties
User
object
28 properties
UserPermissionsResponse
object
2 properties
BlockReasonCode
object
3 properties
Pagination
object
4 properties
UserSingleResponse
object
2 properties
UserListResponse
object
3 properties
ErrorResponse
object
2 properties
UserRef
object
8 properties
DisplayPicture
object
5 properties
Permission
object
4 properties
UserCreateRequest
object
20 properties 3 required
SuccessResponse
object
1 property
UserUpdateRequest
object
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagedly-users-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 Locations API
Engagedly Permissions API
Engagedly User Attributes API