Library Export Jobs

Get all Library Export Jobs

This endpoint retrieves a list of Library Export Job resources. This endpoint and all of the following are only available when the "Import/Export Version 2 (beta)" feature flag is on.

GET /api/v2/library/export/

Query parameters

The following parameters may be used to filter the Library Export Job resources in the response.

Parameter Description
ordering Sort Library Export Jobs by the specified field. Prefix field name with minus to sort descending. Sortable fields: id, status, triggered_by, triggered.
status Given a status, will filter Library Export Jobs by their status. Valid statuses: pending, in_progress, success, fail, cancel.
status__in Given a list of statuses separated by ,s, returns all Library Export Jobs matching specified statuses.
GET /api/v2/library/export/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": 1,
        "status": "success",
        "triggered": "2025-04-25T14:02:07.815516-04:00",
        "triggered_by": {
            "id": 1,
            "email": "admin@example.com",
            "first_name": "Admin",
            "last_name": "Testerton"
        },
        "completed": "2025-04-25T14:02:08.000636-04:00",
        "type": "template",
        "file_format": "json",
        "content_models": ["standard"],
        "errors": {}
    }]
}

Get a specific Library Export Job

This endpoint retrieves a single Library Export Job resource, as specified by the id parameter.

GET /api/v2/library/export/{job_id}/

URL Parameters

Parameter Description
job_id The id of the Library Export Job to retrieve
GET /api/v2/library/export/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "status": "success",
    "triggered": "2025-04-25T14:02:07.815516-04:00",
    "triggered_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton"
    },
    "completed": "2025-04-25T14:02:08.000636-04:00",
    "type": "template",
    "file_format": "json",
    "content_models": ["standard"],
    "errors": {}
}

results matching ""

    No results matching ""