List invitations

GET 
/invitation

Lists the invitations.

Request

Query Parameters

pageSize string

Possible values: >= 1

Default value: 10

The number of items displayed per page.

pageNumber string

Possible values: >= 1

Default value: 1

The sequence number of the current page.

email email
The email address that is used for invitation.
Example: [email protected]
roleIdList string
The list of the role IDs.
Example: role-100001,role-100002
statusList string
The list of invitation statuses. Supported statuses include INACTIVE, ACCEPTED, and EXPIRED. If specified, only the invitations in any of the listed statuses will be returned. If not specified, the invitations in the INACTIVE and EXPIRED will be returned.
Example: ACTIVE,EXPIRED

Header Parameters

x-maxone-role-id string

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The page object.

pageNumber int64

The sequence number of current page.

pageSize int64

The number of items returned per page.

records

object[]

The records in the current page.

Array [

email string

The email address to receive the invitation.

expiredTime int64

The expiration time of the invitation.

id string

The invitation ID.

roleId string

The ID of the role to which the subaccount will be assigned.

status string

Possible values: [PENDING, ACCEPTED, EXPIRED]

The invitation status.

]

total int64

The number of pages in total.

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "pageNumber": 0,
    "pageSize": 0,
    "records": [
      {
        "email": "[email protected]",
        "expiredTime": 1685510869834,
        "id": "invite-100001",
        "roleId": "role-100001",
        "status": "PENDING"
      }
    ],
    "total": 0
  },
  "msg": "string"
}

Loading...