ListInvitations

GET

https://orgs.ezghcloud.com/v1/organizations/{orgId}/invitations

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired

Query parameters

limitoptionalstring
pattern: ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$
cursoroptionalstring
statusoptionalpendingoracceptedordeclinedorrevokedorexpired

Returns

200

Success

JSON

invitationsarray ofobjectrequired
11 properties
- idstringrequired
- organizationIdstringrequired
- emailstringrequired
- groupIdsarray ofstringrequired
- policyIdsarray ofstringrequired
- statuspendingoracceptedordeclinedorrevokedorexpiredrequired
- urlstringrequired
- invitedBystringrequired
- createdAtstringrequired
- expiresAtstringrequired
- respondedAtstringornullrequired
  2 variants
  One of the following:
  string
  null
nextCursorstringornullrequired
2 variants
One of the following:
string
null

400

InvalidCursor | InvalidRequest

JSON

One of the following:

InvalidCursorEncoded
View InvalidCursorEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeinvalid_cursorrequired
  messagestringrequired
InvalidRequestEncoded
View InvalidRequestEncoded schema →
1 properties
- errorobjectrequired
  3 properties
  codeinvalid_requestrequired
  messagestringrequired
  issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

AccessDenied | ForbiddenOrigin

JSON

One of the following:

AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

429

TooManyRequests

JSON

errorobjectrequired
2 properties
- codetoo_many_requestsrequired
- messagestringrequired

500

InternalError

JSON

errorobjectrequired
2 properties
- codeinternal_errorrequired
- messagestringrequired

503

Unavailable

JSON

errorobjectrequired
2 properties
- codeunavailablerequired
- messagestringrequired

{ "invitations": [ { "id": "string", "organizationId": "string", "email": "string", "groupIds": [ "string" ], "policyIds": [ "string" ], "status": "pending", "url": "string", "invitedBy": "string", "createdAt": "string", "expiresAt": "string", "respondedAt": "string" } ], "nextCursor": "string" }