Apps
Inbound API
Inbound API
Free
Integrations
How It Works
1
Generate an API Key: in your workspace settings
2
Authenticate: requests using the API key in headers
3
Access your data: via standard REST endpoints
Authentication
All API requests require an API key passed in the `X-API-Key` header:
```bash
curl -X GET "https://api.nixa.ca/v1/entities" \
-H "X-API-Key: ${NIXA_API_KEY}"
```
Available Endpoints
### Health & Docs
`GET /v1/health` - Check public API reachability
`GET /v1/openapi.json` - Fetch the OpenAPI contract
### Entities
`GET /v1/entities` - List all entities in your workspace
`GET /v1/entities/:id` - Get entity details and schema
### Records
`GET /v1/entities/:id/records` - List records with filtering & pagination
`GET /v1/entities/:id/records/:recordId` - Get a single record
`POST /v1/entities/:id/records` - Create a new record
`PATCH /v1/entities/:id/records/:recordId` - Update a record
`DELETE /v1/entities/:id/records/:recordId` - Delete a record
### Filtering & Pagination
```bash
GET /v1/entities/123/records?status=active
GET /v1/entities/123/records?limit=50&offset=100
GET /v1/entities/123/records?sort=createdAt&order=desc
```
Security Features
### API Key Management
Create multiple API keys with descriptive names
Revoke keys instantly when compromised
Track last usage for each key
Keys are hashed - only shown once at creation
### Rate Limiting
Automatic rate limiting protects your workspace
Configurable limits per API key
Clear error messages when limits exceeded
### Audit Trail
All API access is logged
Track which key accessed what data
Monitor for unusual patterns
Use Cases
Custom Integrations — Connect proprietary systems to Nixa
Mobile Apps — Build custom mobile experiences
Reporting — Pull data into external BI tools
Automation — Script bulk operations
Sync Systems — Keep external databases in sync
IoT Devices — Send sensor data to Nixa
Response Format
All responses follow a consistent JSON structure:
```json
{
"data": [...],
"meta": {
"total": 150,
"limit": 25,
"offset": 0
}
}
```
Error Handling
Errors return appropriate HTTP status codes with details:
```json
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key",
"details": {},
"requestId": "..."
}
}
```
Screenshots
Integrations
More Integrations apps
Ready to Simplify Your Work?
Install your first app in 30 seconds. No credit card required.