Get Compliance Jobs

Retrieves a list of Compliance Jobs filtered by job type and optional status.

GET /2/compliance/jobs

Try it

Get Compliance Jobs

cURL

curl --request GET \
  --url https://api.x.com/2/compliance/jobs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "created_at": "2021-01-06T18:40:40.000Z",
      "download_expires_at": "2021-01-06T18:40:40.000Z",
      "download_url": "<string>",
      "id": "1372966999991541762",
      "status": "created",
      "type": "tweets",
      "upload_expires_at": "2021-01-06T18:40:40.000Z",
      "upload_url": "<string>",
      "name": "my-job"
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "result_count": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

type · enum<string> · required

Type of Compliance Job to list.

Available options: tweets, users

status · enum<string>

Status of Compliance Job to list.

Available options: created, in_progress, failed, complete

compliance_job.fields · enum<string>[]

A comma separated list of ComplianceJob fields to display. The fields available for a ComplianceJob object.

Minimum array length: 1

Available options: created_at, download_expires_at, download_url, id, name, resumable, status, type, upload_expires_at, upload_url

Example:

[
  "created_at",
  "download_expires_at",
  "download_url",
  "id",
  "name",
  "resumable",
  "status",
  "type",
  "upload_expires_at",
  "upload_url"
]

Response

200

application/json

The request has succeeded.

data · object[]

Minimum array length: 1

Show child attributes

data. created_at · string<date-time> · required

Creation time of the compliance job.

Example:

"2021-01-06T18:40:40.000Z"

data. download_expires_at · string<date-time> · required

Expiration time of the download URL.

Example:

"2021-01-06T18:40:40.000Z"

data. download_url · string<uri> · required

URL from which the user will retrieve their compliance results.

data. id · string · required

Compliance Job ID.

Example:

"1372966999991541762"

data. status · enum<string> · required

Status of a compliance job.

Available options: created, in_progress, failed, complete, expired

data. type · enum<string> · required

Type of compliance job to list.

Available options: tweets, users

data. upload_expires_at · string<date-time> · required

Expiration time of the upload URL.

Example:

"2021-01-06T18:40:40.000Z"

data. upload_url · string<uri> · required

URL to which the user will upload their Tweet or user IDs.

data. name · string

User-provided name for a compliance job.

Maximum string length: 64

Example:

"my-job"

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer

meta · object

Show child attributes

meta. result_count · integer<int32>

The number of results returned in this response.