Skip to main content

​
Base URL

All API requests should be made to: 
https://api.getsolum.com

​
Authentication

The Solum Health API supports two authentication methods:

​
API Key

Use an API key in the X-API-Key header. 
curl https://api.getsolum.com/v1/patients \
  -H "X-API-Key: YOUR_API_KEY"
API keys are scoped to a single company. You can create and manage API keys from the Solum dashboard.

​
Multi-Tenancy

All data is scoped to a company. Your authentication credentials determine which company’s data you can access. Every request is automatically filtered to your company’s resources.

​
Error Responses

The API returns errors in a consistent format: 
{
  "detail": {
    "type": "validation_error",
    "code": "invalid_field",
    "message": "A human-readable description of what went wrong",
    "param": "field_name"
  }
}

​
Common HTTP Status Codes

StatusDescription
200Success
201Resource created
400Bad request (invalid parameters)
401Unauthorized (missing or invalid credentials)
403Forbidden (insufficient permissions)
404Resource not found
409Conflict (e.g., version mismatch for optimistic locking)
422Validation error
500Internal server error

​
Soft Deletes

Most resources use soft deletes. When you call DELETE on a resource, it is marked as inactive rather than permanently removed. List endpoints return only active resources by default.

​
Optimistic Locking

Critical resources like Patients, Payors, and Referrals include a version field. When updating these resources, include the current version in your request body. If the version doesn’t match (another update occurred), the API returns a 409 Conflict.

​
Pagination

List endpoints support pagination with skip and limit query parameters: 
curl "https://api.getsolum.com/v1/patients?skip=0&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"