Workspaces
The organization's workspaces — each with its own customers, charges, dunning rules and the rest of the operation's data. A workspace's id or public_id is what goes in the X-Workspace-Id header (see Authentication). This route does not require the header: an integration token sees every workspace of the organization.
| Command | HTTP | Description |
|---|---|---|
workspaces list | GET /v1/workspaces | List workspaces |
Examples
--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.
# List workspaces
kobana dunning workspaces list --fields "id,public_id,name"
# Use one of them in the next calls
export KOBANA_WORKSPACE_ID=WORKSPACE_ID
kobana dunning charges list
Next steps
- Token identity
- Schema introspection — every parameter this resource accepts.