Workspace

Get the workspace

The workspace the API key or OAuth token is scoped to: its name, the caller's role, whether posts need approval, the active plan, and usage against plan limits (connected channels, and posts used during a free trial). Check plan.active and limits before bulk scheduling to avoid 402 responses.

get/v0/workspace

Request

  • Base URL: https://api.schedulin.app
  • URL: https://api.schedulin.app/v0/workspace
  • Auth: one of:
    • API key in header x-api-key
    • OAuth 2 (authorization code, authorization URL https://api.schedulin.app/oauth/authorize, token URL https://api.schedulin.app/oauth/token, scopes: org:read)

Response

OK

idstring required
namestring required
slugstring nullable required
logostring nullable required
createdAtstring date-time required
requireApprovalboolean required

When true, posts written by Members are held for approval before they publish

rolestring nullable required

The caller's role in this workspace (owner, admin or member)

memberCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.