GET /organizations/{organization_id}/shares

Lists all organization shares.

Servers

Path parameters

Name Type Required Description
organization_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

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"

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.