Hanzo
OpenapiIam

Returns your organization's invitations, newest first — who has been asked to…

Returns your organization's invitations, newest first — who has been asked to join, on what terms, and how many seats each invitation still has left.

GET /v1/iam/invitations

Addresshttps://api.hanzo.ai/v1/iam/invitations
MethodGET
Operationget_iam_invitations
AuthAuthorization: Bearer $HANZO_API_KEY

Returns your organization's invitations, newest first — who has been asked to join, on what terms, and how many seats each invitation still has left.

You see your own organization's invitations and no one else's; which organization that is comes from your credentials, not from the request.

Request

1 field.

FieldInTypeRequiredDescription
ownerquerystring

Response

StatusBodyMeaning
200iam.invitations.ListOutputok

200 body — 22 fields.

FieldInTypeAlwaysDescription
invitationsbodyiam.Invitation[]
invitations[].applicationbodystring
invitations[].codebodystring
invitations[].createdAtbodystring (date-time)
invitations[].createdTimebodystring
invitations[].defaultCodebodystring
invitations[].deletedbodyboolean
invitations[].displayNamebodystring
invitations[].emailbodystring
invitations[].idbodystring
invitations[].isRegexpbodyboolean
invitations[].namebodystring
invitations[].ownerbodystring
invitations[].phonebodystring
invitations[].quotabodyinteger
invitations[].signupGroupbodystring
invitations[].statebodystring
invitations[].updatedAtbodystring (date-time)
invitations[].updatedTimebodystring
invitations[].usedCountbodyinteger
invitations[].usernamebodystring
totalbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page