List of segments

Required roles:

  • can_read_segments
get/v1/assets/{asset_id}/segments/

Request

Path parameters

asset_idstring required

Query parameters

sortstring

Sort on field (Comma separated)

idsstring

Only include these segments (Comma separated)

querystring

Search using query

includesstring

Only include fields (Comma separated)

per_pageinteger

The number of items for each page

pageinteger

Which page number to fetch

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

transcription_idstring

Filter segments by transcription_id

version_idstring

Filter segments by version_id

segment_typestring

Filter segments by segment_type

segment_colorstring

Filter segments by segment_color

time_start_millisecondsinteger

Filter segments by time_start_milliseconds

time_end_millisecondsinteger

Filter segments by time_end_milliseconds

time_start_milliseconds__gteinteger

Get segments with start time greater than or equal to time_start_milliseconds__gte

time_end_milliseconds__lteinteger

Get segments with end time less than or equal to time_end_milliseconds__lte

statusstring

Filter segments by status. AWAITED segments are hidden unless a status filter is given

person_idstring

Filter segments by person_id

share_idstring

Filter segments by share_id

project_idstring

Filter segments by project_id

include_usersboolean

Include segment's authors info

include_all_versionsboolean

If true return asset's segments for all versions

Headers

App-IDstring required
Auth-Tokenstring required

Response

Returns a list of segments

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.