---
title: "List crawling sessions"
method: GET
path: "/v4/crawl/sessions"
tags: ["Crawler"]
---

# List crawling sessions

`GET /v4/crawl/sessions`

## Request

- Base URL: `https://api.kadoa.com`
- URL: `https://api.kadoa.com/v4/crawl/sessions`
- Auth: API key in header `x-api-key`

Get paginated list of crawling sessions with optional filtering

## Query parameters

- `page` number
- `pageSize` number
- `userId` string

## Response `200`

200

- ListCrawlerSessionsResponse: Response for listing crawling sessions
  - `data` CrawlerSessionItem[], required: List of sessions
    - `sessionId` string, required: Session ID
    - `configId` string, required: Config ID
    - `domain` string, required: Domain being crawled
    - `startUrls` string[], required: URLs used to start the crawl
    - `userId` string, required: User ID who created the session
    - `createdAt` string, required: Session creation timestamp
    - `activeJobs` number: Number of active jobs (live stat)
    - `waitingJobs` number: Number of waiting jobs (live stat)
    - `crawledPages` number: Number of crawled pages (live stat)
    - `finished` boolean: Whether session has finished
  - `pagination` object, required: Pagination metadata
    - `page` number, required: Current page number
    - `pageSize` number, required: Items per page
    - `totalItems` number, required: Total number of items
    - `totalPages` number, required: Total number of pages
    - `hasMore` boolean, required: Whether there are more pages

## Other responses

- `400`: 400
- `401`: 401
- `500`: 500

---

[API](https://skmtc.dev/kadoa/apis/kadoa-api.md) · [All operations](https://skmtc.dev/kadoa/apis/kadoa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kadoa/apis/kadoa-api/revisions/bf7803c927b4?raw)