List of segments
Required roles:
- can_read_segments
Request
- Base URLhttps://app.iconik.io/API/assets
- Authnone declared. Required headers: App-ID, Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Query parameters
Sort on field (Comma separated)
Only include these segments (Comma separated)
Search using query
Only include fields (Comma separated)
The number of items for each page
Which page number to fetch
If true passed then uses scroll pagination instead of default one
In order to get next batch of results using scroll pagination the scroll_id is required
Filter segments by transcription_id
Filter segments by version_id
Filter segments by segment_type
Filter segments by segment_color
Filter segments by time_start_milliseconds
Filter segments by time_end_milliseconds
Get segments with start time greater than or equal to time_start_milliseconds__gte
Get segments with end time less than or equal to time_end_milliseconds__lte
Filter segments by status. AWAITED segments are hidden unless a status filter is given
Filter segments by person_id
Filter segments by share_id
Filter segments by project_id
Include segment's authors info
If true return asset's segments for all versions
Headers
Response
Returns a list of segments
Changes
No recorded changes to this operation across all 1 revision of this API.