admin.apps.approved.list

List approved apps for an org or workspace.

Facts

Method URL:https://slack.com/api/admin.apps.approved.list
Preferred HTTP method:GET
Accepted content types:application/x-www-form-urlencoded
Rate limiting:Tier 2
Works with:
Token typeRequired scope(s)
useradmin.apps:read 

This App Management API method lists apps approved for installation for a 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.apps:read page for more detailed instructions.

This API method for admins may only be used on Enterprise Grid.

Arguments

token

Authentication token bearing required scopes.

Examplexxxx-xxxxxxxxx-xxxx
cursor

Set cursor to next_cursor returned by the previous call to list items in the next page

Example5c3e53d5
enterprise_id ExampleE0AS553RN
limit

The maximum number of items to return. Must be between 1 - 1000 both inclusive.

Default: 100

Example100
team_id ExampleT0HFE6EBT

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Note: enterprise_id and team_id cannot be used together.

  • Passing enterprise_id will return the list of org-wide approved apps.
  • Passing team_id will return the apps approved for that specific workspace.

Response

Typical success response

{
    "ok": true,
    "approved_apps": [
        {
            "app": {
                "id": "A0W7UKG8E",
                "name": "My Test App",
                "description": "test app",
                "help_url": "https://www.slack.com",
                "privacy_policy_url": "https://www.slack.com",
                "app_homepage_url": "https://www.slack.com",
                "app_directory_url": "https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app",
                "is_app_directory_approved": false,
                "is_internal": false,
                "icons": {
                    "image_32": "https://302674312496446w_2bd4ea1ad1f89a23c242_32.png",
                    "image_36": "https://302674312496446w_2bd4ea1ad1f89a23c242_36.png",
                    "image_48": "https://302674312496446w_2bd4ea1ad1f89a23c242_48.png",
                    "image_64": "https://302674312496446w_2bd4ea1ad1f89a23c242_64.png",
                    "image_72": "https://302674312496446w_2bd4ea1ad1f89a23c242_72.png",
                    "image_96": "https://302674312496446w_2bd4ea1ad1f89a23c242_96.png",
                    "image_128": "https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png",
                    "image_192": "https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png",
                    "image_512": "https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png",
                    "image_1024": "https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png",
                    "image_original": "https://302674446w12496_2bd4ea1ad1f89a23c242_original.png"
                },
                "additional_info": ""
            },
            "scopes": [
                {
                    "name": "bot",
                    "description": "Add the ability for people to direct message or mention @my_test_app",
                    "is_sensitive": true,
                    "token_type": "bot"
                }
            ],
            "date_updated": 1574296707,
            "last_resolved_by": {
                "actor_id": "W0G82F4FD",
                "actor_type": "user"
            }
        }
    ],
    "response_metadata": {
        "next_cursor": ""
    }
}

Typical error response

{
    "ok": false,
    "error": "invalid_auth"
}

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
invalid_cursor

Value passed for cursor was not valid or is no longer valid.

feature_not_enabled

Returned when the Admin APIs feature is not enabled for this team

not_an_admin

This method is only accessible by org/workspace owners and admins

team_not_found

Returned when team id is not found.

too_many_teams_provided

Please provide only team_id OR enterprise_id.

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.

token_revoked

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

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.

missing_scope

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

is_bot

This method cannot be called by a bot user.

invalid_arguments

The method was called with invalid arguments.

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_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.

request_timeout

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

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.