Get export

GET

/v1/exports/{id}

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

• Production

Retrieve details of a specific export job including its status, row count, and file size when completed.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Export job identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Export details retrieved successfully

Media typeapplication/json

object

data

object

id

Export job identifier

string format: uuid

project_id

Project that owns this export

string

status

Export job status:

• pending: Queued for processing
• processing: Currently generating the CSV
• completed: Ready for download
• failed: Generation failed
• expired: Download link has expired

string

Allowed values: pending processing completed failed expired

filter_start_time

Start of the export time range

string format: date-time

filter_end_time

End of the export time range

string format: date-time

filter_status

Message status filter (if specified)

string

filter_endpoint_id

Outbound endpoint ID filter (if specified, stored as UUID)

string format: uuid

filter_inbound_endpoint_id

Inbound endpoint ID filter (if specified, when direction=inbound)

string format: uuid

direction

Export direction

string

Allowed values: outbound inbound

row_count

Number of rows in the export (populated after completion)

integer

file_size_bytes

File size in bytes (populated after completion)

integer

error_message

Error description (if failed)

string

started_at

When processing started

string format: date-time

completed_at

When processing completed

string format: date-time

expires_at

When the download link expires

string format: date-time

created_at

When the export was requested

string format: date-time

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

{
  "data": {
    "id": "01935abc-def0-7123-4567-890abcdef012",
    "project_id": "proj_abc123",
    "status": "completed",
    "filter_start_time": "2025-12-01T00:00:00Z",
    "filter_end_time": "2025-12-06T23:59:59Z",
    "filter_status": "failed_permanent",
    "row_count": 5000,
    "file_size_bytes": 1024000,
    "started_at": "2025-12-06T12:00:30Z",
    "completed_at": "2025-12-06T12:05:00Z",
    "expires_at": "2025-12-13T12:05:00Z",
    "created_at": "2025-12-06T12:00:00Z"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

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

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "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"
  }
}