The Onboarding API provides access to the details of your onboarding wizards.
Required permissions
To use the onboarding endpoints, the service user should be granted:
| Endpoint | Permission |
|---|---|
| Get a summary of all onboarding wizards. | Features > Settings > 'Welcome' flow > Customize the welcome flow |
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.
Below is a table detailing the rate limits for each endpoint in the Onboarding endpoints.
| Method | Endpoint | Limit per minute |
|---|---|---|
| GET | Get a summary of all onboarding wizards | 20 |