Download export

GET

/v1/exports/{id}/download

curl --request GET \
  --url https://api.hookbridge.io/v1/exports/01935abc-def0-7123-4567-890abcdef012/download \
  --header 'Authorization: Bearer <token>'

• Production

Download a completed export file. Returns a 302 redirect to a presigned S3 URL for the CSV file. The export must be in “completed” status.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Export job identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

302

Redirect to presigned download URL

Headers

Location

string format: uri

Presigned S3 URL for the export CSV file

400

Export not ready for download

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "EXPORT_NOT_READY",
    "message": "Export is not yet completed"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

404

Resource not found

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

410

Export download link has expired

Media typeapplication/json

object

error

object

code

Machine-readable error code

string

message

Human-readable error message

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "error": {
    "code": "EXPORT_EXPIRED",
    "message": "Export download link has expired"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}