Skip to main content
GET
/
crawl
Get paginated crawl jobs
curl --request GET \
  --url https://api.open.cx/crawl \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "org_id": "<string>",
      "url": "<string>",
      "status": "cancelled",
      "created_at": "<string>",
      "updated_at": "<string>",
      "completed_at": "<string>",
      "completed_pages": 123,
      "error_message": "<string>",
      "total_pages": 123
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123,
  "hasNextPage": true,
  "hasPrevPage": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
cancelled,
completed,
failed,
scraping

Response

Crawl jobs retrieved successfully.

​
data
object[]
required
​
total
number
required
​
page
number
required
​
limit
number
required
​
totalPages
number
required
​
hasNextPage
boolean
required
​
hasPrevPage
boolean
required