List Assets for Multiple Segments

Retrieves a list of all assets attached to multiple segments in a single request, including their metadata and download URLs.

URL

(GET) /api/resources/assets/list

PARAMETERS

Parameter	Type	Required	Description
scope (Query)	string	Mandatory	The scope parameter that defines the project or job context. Formats: `pr{projectid}` (e.g., `pr7214`), `jbs{jobid}` for standard jobs, `jbc{jobid}` for Codyt jobs
segmentIds (Query)	string	Mandatory	Comma-separated list of segment IDs to retrieve assets from. Example: `27665601,27665602`

ACCESS RIGHTS

The user must have access rights to the project's reference material. The system checks project-level permissions to ensure the user can list assets from the specified scope.

EXAMPLE REQUEST

CODE

curl --location '{{URL}}/api/resources/assets/list?scope=pr7214&segmentIds=27665601%2C27665602' \
--header 'X-Auth-Token: {{AUTH_TOKEN}}' \
--header 'X-Auth-AccountId: {{ACCOUNT_ID}}'

RESULTS

The response contains a JSON array of asset objects from all specified segments. Each asset object has the following properties:

Property	Type	Description
projectId	int	The project identifier extracted from the scope
documentId	int	The document identifier that contains the segment
segmentId	int	The segment identifier containing the asset
locale	string?	The language code if the asset is associated with a specific language
relativePath	string	The relative path within the segment's asset folder. Empty string if the asset is stored at the root level (segment)
name	string	The stored filename
size	int	The file size in bytes
contentType	string	The MIME type of the asset file
createdDate	datetime	ISO 8601 timestamp when the asset was first created
modifiedDate	datetime	ISO 8601 timestamp when the asset was last modified
downloadUrl	string	Direct URL to download the asset. Includes locale, scope, filename, and version parameters

EXAMPLE RESPONSE

CODE

[
    {
        "projectId": 7214,
        "documentId": 19641,
        "segmentId": 27665601,
        "locale": "en",
        "relativePath": "",
        "name": "pexels-gons3.jpg",
        "size": 2268156,
        "contentType": "image/jpeg",
        "createdDate": "2025-07-27T15:58:53.4687698Z",
        "modifiedDate": "2025-07-27T16:14:48.0402178Z",
        "downloadUrl": "{{URL}}/api/resources/assets/27665601?locale=en&scope=pr7214&filename=pexels-gons3.jpg&v=638892296880402178"
    }
]

USAGE NOTES

Returns an empty array [] if no assets are found in any of the specified segments
Assets from all specified segments are combined in a single response
User must have access to all segments to be able to download from them.