Help Center/ Organizations/ API Reference/ APIs/ Managing Invitations/ Listing Sent Invitations
Updated on 2026-03-05 GMT+08:00
View PDF

Listing Sent Invitations

Function

This API is used to list all the invitations sent by an organization. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    organizations:handshakes:list

    List

    -

    -

    -

    -

URI

GET /v1/organizations/handshakes

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of results on the page. If the limit is not specified, the default value is 1,000.

marker

No

String

Pagination marker.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

handshakes

Array of HandshakeDto objects

List of invitation (handshake) objects with details about each of the invitations (handshakes) associated with the specified account.

page_info

PageInfoDto object

Pagination information.
Table 4 HandshakeDto

Parameter

Type

Description

id

String

Unique ID of an invitation (handshake). The originating account creates the ID when initiating the invitation (handshake).

urn

String

Uniform resource name of the invitation (handshake).

updated_at

String

Date and time when an invitation (handshake) request was accepted, canceled, declined, or expired.

created_at

String

Date and time when an invitation (handshake) request was made.

expired_at

String

The date and time the invitation (handshake) expires.

management_account_id

String

Unique ID of the organization's management account.

management_account_name

String

Name of the organization's management account.

organization_id

String

Unique ID of an organization.

notes

String

Additional information that you want to include in the email to the recipient account owner.

target

TargetDto object

ID of the account that you want to invite to join your organization.

status

String

Current state of the invitation (handshake). It can be pending, accepted, cancelled, declined, or expired.
Table 5 TargetDto

Parameter

Type

Description

type

String

Target type. It can be account ID or name.

entity

String

If you choose type:account, you must provide the account ID. If you choose type:name, you must specify the account name.
Table 6 PageInfoDto

Parameter

Type

Description

next_marker

String

Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null.

current_count

Integer

Number of items returned on the current page.

Example Requests

Listing sent invitations

GET https://{endpoint}/v1/organizations/handshakes

Example Responses

Status code: 200

Successful.

{
  "handshakes" : [ {
    "id" : "h-2tnfkrhe64qokwripd2kqrhd7d3079u5",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
    "updated_at" : "2022-09-23T07:38:15Z",
    "created_at" : "2022-09-23T07:38:15Z",
    "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "management_account_name" : "paas_iam_573331",
    "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
    "notes" : "test-notes",
    "target" : {
      "type" : "account",
      "entity" : "644c579bea6d473e8ce386e0e8ec449d"
    },
    "status" : "cancelled"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Managing Invitations