API referenceExtractions
List projects
GET
/extractionsReturns both normal projects and quick-extraction workspaces; each row carries an isQuick flag telling them apart. Since POST /extractions defaults to isQuick:true, a project you create through the API appears here by default. Use ?isQuick= to narrow to one kind, ?name= for an exact title match, or ?search= for a partial match.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Query Parameters
name?string
Exact title match
search?string
Partial match
isQuick?boolean
Narrow to quick-extraction workspaces (true) or normal projects (false). Omit to return both.
status?string
Defaults to active, so inactive projects are hidden unless you ask for them.
Default
"active"Value in
- "all"
- "active"
- "inactive"
moduleId?string
Format
uuidsortBy?string
Default
"title"Value in
- "title"
- "completionRate"
- "createdAt"
sortOrder?string
Default
"asc"Value in
- "asc"
- "desc"
limit?integer
Max rows to return (default 50, max 1000).
Range
1 <= value <= 1000Default
50offset?integer
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/extractions"{ "data": { "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "moduleId": "eb49de5a-d93f-4a73-a032-bfeee6879098", "isActive": true, "inactivatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "isQuick": true, "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "module": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "path": "string" }, "extractionStats": { "total": 0, "completed": 0, "failed": 0, "inProgress": 0, "pending": 0 } } ], "total": 0 }, "meta": { "requestId": "string", "timestamp": "string" }}