Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.provisionr.io/llms.txt

Use this file to discover all available pages before exploring further.

The Provisionr Workspace API is a RESTful API that allows you to manage your workspace’s directory, policies, integrations, and access controls programmatically.

​
Base URL

Each workspace has a unique API endpoint based on its workspace identifier. 
https://wks-{8char}.provisionr.io/api/v1
Replace wks-{8char} with your workspace’s unique subdomain.

​
Request Format

All request bodies should be sent as JSON with the Content-Type: application/json header. 
curl https://wks-a1b2c3d4.provisionr.io/api/v1/directory/users \
  -H "Authorization: Bearer prv-your-token" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

​
Response Format

All responses are returned as JSON. Successful responses use standard HTTP status codes:
Status CodeDescription
200Successful read operation
201Resource created successfully
202Resource updated successfully
204Resource deleted successfully

​
Error Handling

Error responses follow a consistent structure with a message field describing the error.
Status CodeDescription
401Unauthenticated — missing or invalid token
403Unauthorized — insufficient permissions
404Resource not found
422Validation error — check the errors field for details
Validation errors include a field-level breakdown: 
{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field is required."
        ]
    }
}

Authentication

Learn how to authenticate your API requests.

Pagination

Navigate large result sets with cursor-based pagination.

Filters

Filter, sort, and include related data in your queries.

CLI Reference

Prefer a command-line interface? Check out the CLI.