/admin.inviteRequests.list

GET

List all pending workspace invite requests.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://slack.com/api/admin.inviteRequests.list' \
--header 'token;'

Response Example

200 - response

{
    "ok": true
}

Request

Query Params

team_id

string

optional

ID for the workspace where the invite requests were made.

cursor

string

optional

Value of the next_cursor field sent as part of the previous API response

limit

integer

optional

The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive

Header Params

token

string

required

Authentication token. Requires scope: admin.invites:read

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response

Modified at 2023-08-15 05:39:45