ListReceivedInvitations

GET

https://orgs.ezghcloud.com/v1/invitations

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Query parameters

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

Returns

200

Success

JSON

invitationsarray ofobjectrequired
9 properties
- idstringrequired
- organizationobjectrequired
  3 properties
  idstringrequired
  namestringrequired
  slugstringrequired
- emailstringrequired
- invitedByEmailstringornullrequired
  2 variants
  One of the following:
  string
  null
- statuspendingoracceptedordeclinedorrevokedorexpiredrequired
- urlstringrequired
- 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

Forbidden | EmailNotVerified | AccessDenied | ForbiddenOrigin

JSON

One of the following:

ForbiddenEncoded
View ForbiddenEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbiddenrequired
  messagestringrequired
EmailNotVerifiedEncoded
View EmailNotVerifiedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeemail_not_verifiedrequired
  messagestringrequired
AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  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", "organization": { "id": "string", "name": "string", "slug": "string" }, "email": "string", "invitedByEmail": "string", "status": "pending", "url": "string", "createdAt": "string", "expiresAt": "string", "respondedAt": "string" } ], "nextCursor": "string" }