Query a datastore for items

Notices

This method requires a paid plan. Don't have a paid plan? Join the Developer Program and provision a sandbox with access to all Slack features for free.

Facts

Method access

HTTP
POSThttps://slack.com/api/apps.datastore.query

Required scopes

Content types

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

    Tier 4
  • Arguments

    Required arguments

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

    Example
    xxxx-xxxxxxxxx-xxxx

    Name of the datastore

    Optional arguments

    Required if calling with user token

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

    Example
    5c3e53d5

    A query filter expression https://api.slack.com/future/datastores

    Example
    #artist = :artist_name

    A map of attributes referenced in expression

    Example
    { "#artist": "artist" }

    A map of values referenced in expression

    Example
    { ":artist_name": "Fred Rogers" }

    The maximum number of items to evaluate for a given request (not necessarily the number of matching items). If the given request dataset size exceeds 1 MB before reaching the limit, the returned item count will likely be less than the limit. In any case where there are more items available beyond an imposed limit, a next_cursor value will be provided for use in subsequent requests.

    Default
    100
    Example
    100

    Usage info

    This method is only available for workflow apps. Refer to Datastores for more information.

    This method is used to query a datastore and uses a DynamoDB style of syntax. The following example would retrieve all records from the "good_tunes" datastore where "You" is in the song title.

    {
    	"datastore": "good_tunes",
    	"expression": "contains (#song, :keyword)",
    	"expression_attributes": { "#song": "song" },
    	"expression_values": { ":keyword": "You" }
    }
    

    See Datastores for a more in-depth exploration.

    Example responses

    Common successful response

    Typical success response

    {
        "ok": true,
        "datastore": "good_tunes",
        "items": [
            {
                "artist": "Whitney Houston",
                "song": "I Will Always Love You",
                "id": "4"
            },
            {
                "artist": "Fred Rogers",
                "song": "Won't You Be My Neighbor?",
                "id": "5"
            }
        ]
    }

    Common error response

    Error response for invalid datastore parameter

    {
        "ok": false,
        "error": "datastore_error",
        "errors": [
            {
                "code": "datastore_config_not_found",
                "message": "The datastore configuration could not be found",
                "pointer": "/datastores"
            }
        ]
    }

    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_arguments

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

    invalid_datastore

    The provided datastore is invalid.

    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.

    app_not_hosted

    The app developer is not using a Slack-hosted environment. App datastores are exclusively available for Slack-hosted apps.

    datastore_error

    Datastore error

    access_denied

    Access to a resource specified in the request is denied.

    invalid_app_id

    The app_id provided is not valid for team and user.

    free_team_not_allowed

    Datastore query not allowed on a free team.

    team_quota_exceeded

    Total number of requests exceeded team quota.

    datastore_migration_in_progress

    The datastore is currently unavailable due to an in progress Enterprise Grid migration.

    restricted_plan_level

    Feature is not available on this team

    account_inactive

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

    deprecated_endpoint

    The endpoint has been deprecated.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    is_bot

    This method cannot be called by a legacy bot.

    method_deprecated

    The method has been deprecated.

    missing_scope

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

    not_allowed_token_type

    The token type used in this request is not allowed.

    not_authed

    No authentication token provided.

    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.

    token_expired

    Authentication token has expired

    token_revoked

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

    two_factor_setup_required

    Two factor setup is required.

    accesslimited

    Access to this method is limited on the current network

    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.

    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.

    ratelimited

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

    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

    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.

    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