Base URL
All API requests should be made to:Authentication
Before making any API requests, you’ll need to authenticate. FirstQuadrant supports two authentication methods:- API Keys - Best for server-to-server integrations
- Access Tokens - For user-specific actions
Making your first request
Here’s a simple example to test your authentication and get your user profile:Response format
All successful API responses return JSON data. The response will vary based on the endpoint, but typically follows these patterns:Single resource
Resource collection
Common headers
Request headers
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token or API key |
FirstQuadrant-Organization-ID | Yes* | Organization context (required for API keys) |
Content-Type | Yes** | application/json for POST/PUT/PATCH requests |
Response headers
Header | Description |
---|---|
X-Request-Id | Unique identifier for the request |
Version | API version information |
ETag | Entity tag for caching |
Next steps
Now that you’ve made your first API call, explore these topics:- Error Handling - Learn how to handle API errors
- Pagination - Work with large datasets
- Filtering - Query and filter resources
- Best Practices - Tips for efficient API usage
API explorer
You can explore all available endpoints and test them interactively using our API documentation:- OpenAPI Specification: https://api.us.firstquadrant.ai/v5/docs
- Swagger UI: https://api.us.firstquadrant.ai/v5/swagger
Support
If you have questions or need help with the API:- Check our API Reference for detailed endpoint documentation
- Review Best Practices for common patterns
- Contact support at [email protected]