added
Added completed_at field to company onboarding status endpoint
about 2 hours ago
Added completion timestamps to the GET /v1/company/onboarding_status endpoint to help you track when your companies complete each onboarding step. This enables you to integrate with marketing automation platforms (e.g., Mailchimp, Iterable) and send targeted onboarding nudges when companies get stuck.
The following field is now available in each onboarding step:
completed_at
- the datetime when the onboarding step was completed (ISO format)
Example response
{
"uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
"onboarding_completed": false,
"onboarding_steps": [
{
"title": "Add Your Company's Addresses",
"id": "add_addresses",
"required": true,
"completed": true,
"skippable": false,
"completed_at": "2025-07-10T11:54:00.00Z", // New "completed_at" field
"requirements": []
},
[...]
]
}
The completed_at
field returns null for incomplete steps. Read more about company onboarding in the API documentation.