Skip to main content

conversations.requestSharedInvite.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 Slack Connect API method lists requested Slack Connect invitations.

Prerequisites​

  • You must have administrator access to a workspace that is part of an Enterprise Grid plan.
  • You must have the following settings configured within your Admin Dashboard under Slack Connect Settings: a) Toggle on the Apply automation rules before channel invitations are sent preference. b) Under Channels, toggle on either the Sending Invitations with Permission to Post Only or the Sending Invitations with permission to post, invite and more preference.

For more details, refer to governing Slack Connect invites.

Using the user_id argument​

The optional user_id argument allows the caller to filter requested invitations by a given user.

Using the include_approved argument​

The optional include_approved argument will return approved requested invitations in the API response. By default approved requested invitations are not returned.

Using the include_denied argument​

The optional include_denied argument will return denied requested invitations in the API response. By default denied requested invitations are not returned.

Using the include_expired argument​

The optional include_expired argument will return expired requested invitations in the API response. By default expired requested invitations are not returned.

Using the invite_ids argument​

The optional invite_ids will return a list of requested invitations with matching IDs. All other filters are applicable in combination with this filter.

Response​

Returns a list of paginated requested invitations objects ordered by IDs in ascending order.

Pagination​

This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a limit value under 1000. We recommend no more than 200 results at a time.

Responses will include a top-level response_metadata attribute containing a next_cursor value. By using this value as a cursor parameter in a subsequent request, along with limit, you may navigate through the collection page by virtual page.

See pagination for more information.