Skip to main content
GET
メンバー招待を一覧表示

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

fields
string

結果に含める、または除外するフィールドのカンマ区切りリスト(include_fields に指定した値に応じます)。すべてのフィールドを取得するには空のままにします。注: ticket_id では絞り込みできず、この値はフィールドを絞り込んでいない場合にのみ返されます。

Required string length: 1 - 255
Pattern: ^(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url)(,(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url))*$
include_fields
boolean
デフォルト:true

指定したフィールドを含める(true)か、除外する(false)か。既定値は true です。

from
string

選択を開始する位置を示す任意のカーソル(この値自体は含まれません)。

Required string length: 1 - 1000
take
integer
デフォルト:50

1ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100
sort
string
デフォルト:created_at:-1

並べ替えるフィールド。order には昇順の場合は 1、降順の場合は -1 を指定し、field:order の形式で指定します。既定値は created_at:-1 です。

Pattern: ^created_at:(1|-1)$
include_totals
boolean
デフォルト:false

trueの場合、レスポンスには結果セット内の項目数の'total'(有効なフィルターを反映)と'total_is_capped'フラグが含まれます。件数はベストエフォートで算出され、上限は1000です。実際の件数がそれを超える可能性がある場合、'total_is_capped'はtrueとなり、'total'は下限値となります。要求されない場合は省略されます。

レスポンス

Organizationのメンバー招待を一覧表示します。

next
string

結果の次のページのページネーションカーソル。

total
integer
read-only

結果セット内の保留中の招待数のベストエフォート値(有効なフィルターを反映)。include_totals=trueの場合にのみ含まれます。上限は1000です。

total_is_capped
boolean
read-only

結果セットの実際の件数に達する前にカウントが停止したかどうか。trueの場合、'total'は下限値です(実際の件数は'total'以上)。falseの場合、'total'はカウントされた結果セット全体の件数を示します。'total'が存在する場合にのみ含まれます。

invitations
object[]