Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
batches
List Batches
curl --request GET \
  --url https://api.theary.ai/background-check/v1/batches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {}
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

​
List Background Check Batches

Retrieves a paginated list of background check batches for a specific authenticated tenant.

​
Request

​
page
string
required
Page number for pagination (1-based)
​
limit
string
required
Number of batches per page

​
Response

​
data
array
Array of batch objects
​
pagination
object
Pagination metadata

​
Example Request

curl -X GET "https://api.theary.ai/background-check/v1/batches?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

​
Example Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "completed",
      "orderCount": 25,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:45:00Z",
      "createdBy": "user_123",
      "entityName": "Apple Inc."
    },
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "status": "in_progress",
      "orderCount": 15,
      "createdAt": "2024-01-14T09:15:00Z",
      "updatedAt": "2024-01-15T16:20:00Z",
      "createdBy": "user_456",
      "entityName": "Google LLC"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3
  }
}