API Reference
Builda provides REST and GraphQL APIs for developer integrations, custom frontends, and automation.
API Reference
Builda provides REST and GraphQL APIs for developer integrations, custom frontends, and automation.
Base URL
https://{your-company}-api.builda.io/api/v1/
Available APIs
| API | Endpoint | Use Case |
|---|---|---|
| REST | /api/v1/* | CRUD operations, standard integrations |
| GraphQL | /graphql | Flexible queries, custom frontend data needs |
Authentication
All API requests require a Bearer token (Laravel Sanctum). See Authentication.
Response Format
All REST responses follow a standardised JSON envelope:
{
"success": true,
"data": { ... },
"message": "Success"
}
Error responses:
{
"success": false,
"message": "Error description",
"errors": { ... }
}
Rate Limiting
API requests are rate-limited. Contact the Builda team if you need higher limits for your use case.
Guides
| Guide | What You'll Learn |
|---|---|
| Authentication | Getting and using API tokens |
| REST API | Available endpoints, filtering, pagination |
| GraphQL | Schema, queries, mutations |
| Errors | Error codes and troubleshooting |