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

CSV and JSON-based provisioning workflows

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

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

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

2 operations 2 paths 4 schemas 2 POST

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 Provisioning 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Provisioning 2

CSV and JSON-based provisioning workflows

POST
/provisioning/csv
Schedule a csv provisioning
processCsvProvisioning body → 202400401403
POST
/provisioning/json
Schedule a json provisioning
processJsonProvisioning body → 202400401403

Schemas 4

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

Error
object
3 properties
CreateUserRequest
object
6 properties 3 required
ProvisioningResponse
object
3 properties
JsonProvisioningRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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