Skip to main content
GET
/
external
/
v1
/
external_billing_data_export
Billing Export
curl --request GET \
  --url https://api.example.com/external/v1/external_billing_data_export

​
Export Billing Data

Export billable event data from Firstwork for external billing, invoicing, or reporting systems.

​
Endpoint

GET /external/v1/external_billing_data_export

​
Query Parameters

ParameterTypeRequiredDescription
start_datestring (ISO 8601)NoStart of the billing period
end_datestring (ISO 8601)NoEnd of the billing period

​
Example Request

curl -X GET "https://your-instance.firstwork.com/external/v1/external_billing_data_export?start_date=2025-01-01&end_date=2025-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "status": "success",
  "data": {
    "period": {
      "start": "2025-01-01T00:00:00Z",
      "end": "2025-01-31T23:59:59Z"
    },
    "events": [
      {
        "id": "event-uuid",
        "type": "application_created",
        "timestamp": "2025-01-15T10:30:00Z",
        "metadata": {
          "hiring_flow": "Software Engineer",
          "source": "api"
        }
      }
    ],
    "summary": {
      "total_events": 1250,
      "by_type": {
        "application_created": 450,
        "sms_sent": 320,
        "email_sent": 480
      }
    }
  }
}

​
Notes

  • Billing events track usage-based items (applications created, messages sent, etc.)
  • Data can be used for internal cost allocation or client billing
  • Export format is designed for easy import into billing systems