Org Team

List WorkOS invitations for this org (pending by default)

get/v1/orgs/{workosOrgId}/invitations

Request

Base URL
https://api.vendure.io (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/vendure/apis/vendure-io-api-public/docs/v1/orgs/:workosOrgId/invitations/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workosOrgIdstring required

Query parameters

state'pending' | 'accepted' | 'expired' | 'revoked' | 'all'

Filter invitations by state. Defaults to "pending".

Response

hasMoreboolean required

True when the first page was saturated — callers should contact support instead of paging further.

Changes

No recorded changes to this operation across all 4 revisions of this API.