Skip to main content
GET https://xquik.com/api/v1/extractions
Free. This endpoint does not consume credits.

Headers

Query parameters

Response

200 OK

401 Unauthenticated

Missing or invalid API key.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 } Wait for the Retry-After value before making another request.

Pagination

The API orders results by creation date, newest first. Follow these steps to read every extraction.
  1. Make the initial request without the cursor parameter.
  2. Check hasMore. Pass nextCursor as the next cursor value.
  3. Repeat until hasMore is false.

Job inventory handoff

Use GET /extractions as the job inventory step before fetching details or exporting files. Treat nextCursor as opaque and pass it back as cursor. Do not write raw job lists to shared logs.

Page checkpoint

Store page_index, page_cursor, next_cursor, has_more, limit, tool_type_filter, and status_filter after each successful page.

Completed jobs

Store these completed job fields for the next fetch or file export. They are id, toolType, totalResults, completedAt, detail_path, and export_path.

Running or failed jobs

Keep status, createdAt, and id. That lets dashboards retry failed jobs or poll running jobs without rereading older pages.

Next API step

Use Get Extraction for paginated JSON rows, or Export Extraction for files.
Store page checkpoints separately from job rows.
Next steps.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }