GET /accounts/{account_id}/shares

Lists all account shares.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Query parameters

Name Type Required Description
page Integer No

Page number. Defaults to 1 when per_page is supplied without page. May be omitted entirely along with per_page to receive a non-paginated response.

Default value: 1

include_resources Boolean No

Include resources in the response.

order String No

Order shares by values in the given field.

Valid values:

  • "created"
  • "name"

Default value: "created"

direction String No

Direction to sort objects.

Valid values:

  • "desc"
  • "asc"

Default value: "asc"

per_page Integer No

Number of objects to return per page. Defaults to 20 when page is supplied without per_page. May be omitted entirely along with page to receive a non-paginated response.

Default value: 20

status String No

Filter shares by status.

Valid values:

  • "active"
  • "deleting"
  • "deleted"
resource_types[] Array No

Filter share resources by resource_types.

kind String No

Filter shares by kind.

Valid values:

  • "sent"
  • "received"
target_type String No

Filter shares by target_type.

Valid values:

  • "organization"
  • "account"
tag[] Array No

Filter shares by tag. Each value is either key=value (matches shares whose tags contain that key/value pair) or key alone (matches shares that have any value for that key). May be repeated; multiple tag parameters are ANDed together. Maximum 20 tag parameters per request.

include_recipient_counts Boolean No

Include recipient counts in the response.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.