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

Workleap Users API

User management and provisioning

Workleap Users API is one of 7 APIs that Workleap 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 9 operations across 7 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.workleap.com/public.

9 operations 7 paths 7 schemas 1 DELETE1 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.workleap.com
Authentication
API Key
License
Proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Workleap Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as workleap-subscription-key (SubscriptionKey). By default, every request must be authenticated.

  • SubscriptionKey — API key for authenticating requests to the Workleap API

Paths & Operations 9

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

Users 9

User management and provisioning

POST
/users/activate
Activate users
activateUsers body → 200400401403
POST
/users
Create a user
createUser body → 201400401403409
POST
/users/deactivate
Deactivate users
deactivateUsers body → 200400401403
GET
/users/{userId}
Get a user
getUser 1 param → 200401403404
PUT
/users/{userId}
Update a user
updateUser 1 param body → 200400401403404
DELETE
/users/{userId}
Delete a user
deleteUser 1 param → 204401403404
POST
/users/search
Search users
searchUsers body → 200400401403
PUT
/users/{userId}/avatar
Update a user avatar
updateUserAvatar 1 param body → 200400401403404
PUT
/users/avatar
Update a user avatar by email
updateUserAvatarByEmail body → 200400401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (10 properties), CreateUserRequest (6 properties), UpdateUserRequest (5 properties), UserSearchRequest (4 properties). Each schema is shown below with its type and property counts.

UserStateChangeRequest
object
1 property 1 required
Error
object
3 properties
UserSearchRequest
object
4 properties
UpdateUserRequest
object
5 properties
User
object
10 properties
CreateUserRequest
object
6 properties 3 required
UserStateChangeResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workleap-users-api-openapi.yml Raw ↑

Other APIs Workleap publishes across the network.

Workleap Attributes API
Workleap Engagement API
Workleap Feedback API
Workleap GoodVibes API
Workleap Groups API
Workleap Provisioning API