admin.inviteRequests.approved.list

List all approved workspace invite requests.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/admin.inviteRequests.approved.list
Bolt for Java
app.client().adminInviteRequestsApprovedList
Powered by Bolt
Bolt for Python
app.client.admin_inviteRequests_approved_list
Powered by Bolt
Bolt for JavaScript
app.client.admin.inviteRequests.approved.list
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 2
  • Arguments

    ArgumentTypeDescription
    tokenRequired

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Examplexxxx-xxxxxxxxx-xxxx
    cursor
    string

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

    Example5cweb43
    limit
    integer

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

    Default: 100

    Example100
    team_id
    string

    ID for the workspace where the invite requests were made.

    Example

    This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

    Example responses

    This invite request management API method lists workspace invite requests that have already been approved.

    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.

        {
            "ok": true,
            "approved_requests": [
                [
                    "invite_request": [
                        "id": "IrNKPK5TK3",
                        "email": "foo@example.com",
                        "date_created": "1616127454"
                        "requester_ids": [
                            "UNKPK5TJM"
                        ],
                        "channel_ids": [
                            "CNKPK5TJW",
                            "CNKPK5TJH"
                        ],
                        "invite_type": "full_member",
                        "real_name": null,
                        "date_expire": null,
                        "request_reason" null
                    ],
                    "approved_by": [
                        "actor_id": "UNKPK5TJB",
                        "actor_type": "user"
                    ],
                    "invite": [
                        "id": "INKPK5TK4",
                        "inviter_id": "UNKPK5TJM",
                        "email": "foo@example.com",
                        "date_created": 1616127724,
                        "date_resent": null,
                        "is_bouncing": false,
                        "invite_preferences": [
                            "is_restricted": false,
                            "is_ultra_restricted": false,
                            "date_expire": null,
                            "channel_ids": [
                                "CNKPK5TJW",
                                "CNKPK5TJH"
                            ],
                            "is_domain_matched": false,
                            "real_name": null
                        ],
                    ],
                ],  
                [
                    "invite_request": [
                        "id": "IrNKPK5TG3",
                        "email": "foo2@example.com",
                        "date_created": "161612723454"
                        "requester_ids": [
                            "UNKPK5TJK"
                        ],
                        "channel_ids": [
                            "CNKEK5TJS",
                            "CNKPK5TJG"
                        ],
                        "invite_type": "full_member",
                        "real_name": null,
                        "date_expire": null,
                        "request_reason" null
                    ],
                    "approved_by": [
                        "actor_id": "UNKPK5TJK",
                        "actor_type": "user"
                    ],
                    "invite": [
                        "id": "INKPK5TK4",
                        "inviter_id": "UNKPK5TJM",
                        "email": "foo2@example.com",
                        "date_created": 1616127726,
                        "date_resent": null,
                        "is_bouncing": false,
                        "invite_preferences": [
                            "is_restricted": false,
                            "is_ultra_restricted": false,
                            "date_expire": null,
                            "channel_ids": [
                                "CNKPK5TJW",
                                "CNKPK5TJH"
                            ],
                            "is_domain_matched": false,
                            "real_name": null
                        ],
                    ],
                ],  
            ],
        }
    

    Errors

    This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

    ErrorDescription
    team_not_found

    The team_id specified wasn't found.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_an_admin

    This token doesn't have admin privileges.

    feature_not_enabled

    The Invite Requests admin APIs feature is not enabled

    not_authed

    No authentication token provided.

    invalid_auth

    Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    token_expired

    Authentication token has expired

    no_permission

    The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

    org_login_required

    The workspace is undergoing an enterprise migration and will not be available until migration is complete.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    is_bot

    This method cannot be called by a bot user.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_arg_name

    The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    invalid_charset

    The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    team_added_to_org

    The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    accesslimited

    Access to this method is limited on the current network

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    service_unavailable

    The service is temporarily unavailable

    fatal_error

    The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    Warnings

    This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response

    Was this page helpful?