List Invitations

GET 
/organizations/:organizationId/invitations

List invitations for organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of invitation data objects.
Array [
code stringrequired
organizationId stringrequired
appRole stringrequired
origin stringrequired
email stringrequired
metadata objectrequired
expiredAt stringrequired
usedAt stringrequired
canceledAt stringrequired
createdAtDateString stringrequired
createdAt required
]

Example (from schema)

{
  "data": [
    {
      "code": "string",
      "organizationId": "string",
      "appRole": "string",
      "origin": "string",
      "email": "string",
      "metadata": {},
      "expiredAt": "string",
      "usedAt": "string",
      "canceledAt": "string",
      "createdAtDateString": "string",
      "createdAt": {}
    }
  ]
}

Example

{
  "data": [
    {
      "code": "l9CgQxxxxxxxxxx==",
      "organizationId": "o-organizationId",
      "appRole": "RequesterAndViewer",
      "origin": "Owner",
      "email": "example@infodeck.io",
      "metadata": {},
      "expiredAt": "2024-01-03T00:00:00.000Z",
      "usedAt": null,
      "canceledAt": null,
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...