List Groups

Lists the workspace's groups of members (for example Legal), used as approvers.

Updated

GET
/v1/workspace-groups
curl -X GET "https://api.orshot.com/v1/workspace-groups?includeArchived=<INCLUDE_ARCHIVED>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Lists the workspace's groups of members (for example Legal), used as approvers. Reviewers limited to some approval flows see only the groups they are in and the groups granted on their flows.

Endpoint#

Endpoint
https://api.orshot.com/v1/workspace-groups

Query Parameters#

ParameterTypeRequiredDescription
includeArchivedBooleanNoInclude archived groups. Default false.

Headers#

HeaderRequiredDescription
AuthorizationYesBearer <API key or OAuth token>
x-workspace-idNoOAuth tokens with several workspaces: the workspace to act in. API keys ignore it.
X-Orshot-User-IdNoAPI keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below.
X-Session-IdNoGroups the calls of one agent or MCP session in the activity history.

Acting for a Team Member#

With an API key, you can send X-Orshot-User-Id with the user id of an owner, admin or member of the workspace to make this call for them. The answer then follows both the key's access level and that person's own access. See acting for a team member.

Request#

JavaScript
await fetch("https://api.orshot.com/v1/workspace-groups", {
  headers: { Authorization: "Bearer <ORSHOT_API_KEY>" },
});
JSON
{
  "groups": [
    {
      "id": 1,
      "slug": "legal",
      "name": "Legal",
      "archivedAt": null
    }
  ]
}

Response Fields#

Responds 200 with:

FieldTypeDescription
groupsArrayList of WorkspaceGroup, fields below.
groups[].idIntegerNumeric id.
groups[].slugString
groups[].nameStringDisplay name.
groups[].membersArrayList of Person (on get).
groups[].archivedAtStringISO 8601 timestamp. Can be null.

Error Responses#

Every error has the same body: error, code, message and helpUrl, plus the fields that apply (required, role, context, blockers, violations, issues, current). Branch on error; code is more specific. See the error reference.

Status CodeErrorDescription
401oauth_token_invalidThe OAuth token is invalid, expired or revoked.
403api_key_missingNo Authorization: Bearer header.
403permission_deniedYou don't have access to do this. Ask an owner or admin. code names the capability, for example approval.item.decide_denied; required and role say what was missing. With code: insufficient_scope: the OAuth token lacks workspace:approvals:read. With code: approval.member_header_not_member: X-Orshot-User-Id names someone who isn't an owner, admin or member of the workspace now. With code: approval.member_header_not_allowed: an OAuth token sent X-Orshot-User-Id.
403plan_requiredThe workspace's plan doesn't include Approvals, or doesn't include this part of it.
403enterprise_api_requiredUsing approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on.
404not_foundThis doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access.
422validation_failedSome fields aren't valid: the fields listed in issues. issues lists each field with a path and a reason.
422validation_failedWith code: approval.member_header_invalid: X-Orshot-User-Id isn't a user id.
429rate_limit_exceededMore than 120 approvals requests in a minute from one person or key. Wait for Retry-After.
503approvals_unavailableApprovals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API.
Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required