TechAppForce

REST APIs

Conventions shared by every TechAppForce API.

  • Versioning: routes start with api/v1.
  • Authentication: Authorization: Bearer <token> from the identity service.
  • Context: TenantId, AppId and EnvironmentId headers select where you are working.
  • Results: responses use a result envelope with success, the result, errors and, for lists, the total count.
  • Asynchronous writes: 200 OK with the result, or 202 Accepted with a CorrelationId when processing continues.
  • Documentation: each service publishes its OpenAPI document and Swagger UI on your environment.

Start with the API reference.