Skip to main content

admin.inviteRequests.list method

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Usage info​

This invite request management API method lists pending requests to invite someone to a specific workspace.

This method requires an admin.* scope. It's obtained through the normal OAuth process, but there are a few additional requirements. The scope must be requested by an Enterprise Grid admin or owner, and the OAuth install must take place on the entire Grid org, not an individual workspace. See the admin.invites:read page for more detailed instructions.

team_id is required if your Enterprise Grid org contains more than one workspace.

Response​

    {
        "ok": true,
        "invite_requests": [
            {
                "id": "Ir558ULC1J",
                "email": "foobar@example.com",
                "date_created":1619700970,
                "requester_ids": [
                    "U558ULC10"
                ],
                "channel_ids": [
                    "C558ULC19",
                    "C558ULC0W"
                ],
                "invite_type": "full_member",
                "real_name":null,
                "date_expire":null,
                "request_reason":null
            }
        ],
        "response_metadata": {
            "next_cursor": "ZGF0ZV9jcmVhdGU6MTYxOTcwMDk3MA=="
        }
    }