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

Group management within an organization

Workleap Groups API is one of 7 APIs that Workleap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

6 operations 4 paths 6 schemas 1 DELETE1 GET1 PATCH2 POST1 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 Groups 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 6

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

Groups 6

Group management within an organization

POST
/groups
Create a group
createGroup body → 201400401403
POST
/groups/search
Search groups
searchGroups body → 200400401403
GET
/groups/{groupId}
Get a group
getGroup 1 param → 200401403404
PUT
/groups/{groupId}
Update a group
updateGroup 1 param body → 200400401403404
DELETE
/groups/{groupId}
Delete a group
deleteGroup 1 param → 204401403404
PATCH
/groups/{groupId}/membership
Modify group membership
modifyGroupMembership 1 param body → 200400401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Group (6 properties), GroupSearchRequest (3 properties), Error (3 properties), UpdateGroupRequest (2 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
CreateGroupRequest
object
2 properties 1 required
GroupMembershipRequest
object
2 properties
UpdateGroupRequest
object
2 properties
Group
object
6 properties
GroupSearchRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workleap-groups-api-openapi.yml Raw ↑

Other APIs Workleap publishes across the network.

Workleap Attributes API
Workleap Engagement API
Workleap Feedback API
Workleap GoodVibes API
Workleap Provisioning API
Workleap Users API