Get a list of all domain shares

Required roles:

  • can_manage_all_shares
get/v1/shares/all/

Request

Query parameters

titlestring

Filter by title

object_typestring

Filter by object_type

object_idstring

Filter by object_id

owner_idstring

Filter by owner_id

member_idstring

Filter by member_id

idsstring

Filter list of id:s (comma separated)

querystring

Filter by other parameter with wildcard support

_exists_string

Filter shares that have all fields specified in exists (comma separated)

date_createdstring

Filter by date_created. Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: 2018-01-01T10:00:00Z;2018-01-01T15:00:00Z

date_modifiedstring

Filter by date_modified Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: *;1544450400

expiresstring

Filter by expires Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: *;1544450400

startsstring

Filter by starts Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: *;1544450400

schedule_statusstring

Filter by schedule status (comma separated), derived from starts and expires. One or more of: SCHEDULED, ACTIVE, EXPIRED

pageinteger

Which page number to fetch

per_pageinteger

The number of items for each page

scrollboolean

If true passed then uses scroll pagination instead of default one

scroll_idstring

In order to get next batch of results using scroll pagination the scroll_id is required

sortstring

A comma separated list of fieldnames with order. For example - title,asc;object_type,desc

include_automatic_approval_shareboolean

Include automatic approval shares

Headers

App-IDstring required
Auth-Tokenstring required

Response

Returns a list of shares

facetsobject
first_urlstring
last_urlstring
next_urlstring
pageinteger
pagesinteger
per_pageinteger
prev_urlstring
scroll_idstring
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.