✨ List Agreement V2 backfill jobs | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Retrieve Agreement V2 backfill jobs for the authenticated user’s active organization, ordered by most-recently created first. Supports page / page_size query params (default 50 per page, max 500). Requires administrator or owner role and the Agreement V2 feature flag.

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Retrieve Agreement V2 backfill jobs for the authenticated user's active organization, ordered by most-recently created first. Supports page / page_size query params (default 50 per page, max 500). Requires administrator or owner role and the Agreement V2 feature flag.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

statusstringOptional

Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED.

Response

created_atdatetimeRead-only

job_idintegerRead-only

Database ID of the backfill job

project_idinteger or nullRead-only

Optional specific project to backfill (if null, backfills entire organization)

rq_job_idstring or nullRead-only

Redis queue job ID

triggered_bystringRead-only

User who triggered the backfill

completed_atdatetime or null

error_messagestring

Error message if job failed

progress_dataany

JSON data tracking job progress (matrices_created, errors, etc.)

started_atdatetime or null

statusenum

Current status of the backfill job

PENDING - Pending
QUEUED - Queued
RUNNING - Running
COMPLETED - Completed
FAILED - Failed

Allowed values:

Errors

400

Bad Request Error

403

Forbidden Error

1	[
2	{
3	"created_at": "2024-04-18T12:00:00Z",
4	"job_id": 1024,
5	"project_id": 57,
6	"rq_job_id": "rq:job:8f3a2b7c9d4e",
7	"triggered_by": "alice.jones",
8	"completed_at": "2024-04-20T16:45:00Z",
9	"error_message": "",
10	"progress_data": {
11	"matrices_created": 150,
12	"errors": 0,
13	"percent_complete": 100
14	},
15	"started_at": "2024-04-18T12:05:00Z",
16	"status": "COMPLETED"
17	},
18	{
19	"created_at": "2024-04-21T08:30:00Z",
20	"job_id": 1025,
21	"rq_job_id": "rq:job:9b7c4d2e1f6a",
22	"triggered_by": "bob.smith",
23	"error_message": "",
24	"progress_data": {
25	"matrices_created": 45,
26	"errors": 2,
27	"percent_complete": 30
28	},
29	"started_at": "2024-04-21T08:45:00Z",
30	"status": "RUNNING"
31	},
32	{
33	"created_at": "2024-04-22T10:00:00Z",
34	"job_id": 1026,
35	"project_id": 59,
36	"rq_job_id": "rq:job:7d2e4f9a3b1c",
37	"triggered_by": "carol.williams",
38	"error_message": "Failed to connect to database",
39	"progress_data": {
40	"matrices_created": 0,
41	"errors": 1,
42	"percent_complete": 0
43	},
44	"status": "FAILED"
45	}
46	]

1	curl http://localhost:8000/api/dimensions/backfill/jobs/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json"