List invitations

GET 
/dwsu/:dwServiceUnitId/invitation

Lists the invitations in the specified service unit.

Request

Path Parameters

dwServiceUnitId stringrequired
The ID of the service unit.
Example: dw54321

Query Parameters

status 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.

pageSize string

Possible values: >= 1

Default value: 10

The number of items returned per page.

pageNumber string

Possible values: >= 1

Default value: 1

The sequence number of the current page.

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The paginated list of invitations.

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 [

createTime date-time

The creation time of the invitation.

creatorAccountId string

The ID of the account that is used to send the invitation.

email string

The email address.

expireTime date-time

The expiration time of the invitation.

id string

The invitation ID.

status InvitationStatus

Possible values: [PENDING, ACCEPTED, EXPIRED]

The status of the invitation.

]

total int64

The number of pages in total.

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "pageNumber": 0,
    "pageSize": 0,
    "records": [
      {
        "createTime": "2023-05-16T14:20:11.01+09:00",
        "creatorAccountId": "62023101198877",
        "email": "[email protected]",
        "expireTime": "2023-05-18T14:20:11.01+09:00",
        "id": "867c0ba0-5a53-475b-8194-1f565f6ec197",
        "status": "PENDING"
      }
    ],
    "total": 0
  },
  "msg": "string"
}

Loading...