Skip to main content
GET
Read a website crawl
Requires web:crawl through a scoped Pirehub API key or OAuth token. See Web data for request limits, response fields, crawl lifecycle and error handling. See Authentication for credential headers and quota rules.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Path Parameters

id
string<uuid>
required

Query Parameters

offset
integer
default:0

Use the previous nextOffset; poll the same offset when no new documents are available.

Required range: 0 <= x <= 10000

Response

Successful operation.

success
any
required
data
object
required