Download Extraction

curl --request GET \
  --url https://api.example.com/api/v1/user-extractions/{extraction_id}/download \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

user-extractions

Download Extraction

Download an extraction in the specified format.

This endpoint:

Fetches user_extractions record (validates ownership)
Downloads JSON from extraction-files bucket using storage_path
Parses JSON array of lead objects
Filters columnValues.* fields and strips prefix
Converts to requested format (CSV/Excel/JSON)
Returns as streaming response

Args: extraction_id: The ID of the extraction to download format: Download format (csv, excel, or json) current_user: Authenticated user information settings: Application settings

Returns: File as a streaming response in the requested format

Raises: HTTPException: If extraction not found or access denied

GET

api

user-extractions

{extraction_id}

download

Download Extraction

curl --request GET \
  --url https://api.example.com/api/v1/user-extractions/{extraction_id}/download \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

extraction_id

string

required

Query Parameters

format

string

default:excel

Download format: csv, excel, or json

Pattern: ^(csv|excel|json)$

Response

Successful Response

Process Extraction To Session

Rename Extraction Options