Docs

API reference · Identity and tokens

List open invitations, newest first, with their expiry state

GET/v1/orgs/{org}/invitations
Permission
iam.invitations.read
Operation
iam.invitations.list

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
limitqueryintegerno1 to 100; default 50
cursorquerystringno0 to 200 characters
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Response 200

FieldTypeRequiredNotes
itemsarray of objectyes
items[].idstringyesfor example "inv_01h455vb4pex5vsknk084sn02q"
items[].emailstring (email)yes
items[].rolestringyesone of "owner", "admin", "member"
items[].invitedBystring or nullyes
items[].createdAtstring (date-time)yesUTC, ISO 8601.
items[].expiresAtstring (date-time)yesUTC, ISO 8601.
items[].expiredbooleanyes
nextCursorstring or nullyes