WorkOS groups API
Organize and manage user groups within organizations.
WorkOS groups API is one of 41 APIs that WorkOS 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, API documentation, an API reference, a GitHub repository, a changelog, and pricing.
This API exposes 8 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.1.1, at version 1.0.
Requests are made against 2 base URLs: https://api.workos.com, https://api.workos-test.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
WorkOS groups API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearer).
It accepts HTTP bearer tokens (JWT) (access_token).
By default, every request must be authenticated.
bearer— Your WorkOS API key prefixed with sk. Pass it as a Bearer token: Authorization: Bearer skexample123456789.access_token— An SSO access token returned from the Get a Profile and Token endpoint.
Paths & Operations 8
Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Organize and manage user groups within organizations.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Group (7 properties), GroupList (3 properties), UserlandUserOrganizationMembershipBaseList (3 properties), CreateGroupDto (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WorkOS 12
Other APIs WorkOS publishes across the network.