Fortress API Reference

Welcome to the Fortress API reference documentation. This API provides comprehensive access to manage properties, units, tenants, and all related operations in the Fortress platform.

Response Headers

Pagination Information

For endpoints that return lists of resources, we include the x-total-count header in the response. This header contains the total number of records that match your query, which is particularly useful for pagination.

Example response headers:

1x-total-count: 157

This means there are 157 total records matching your query criteria, regardless of the page size or current page you’re viewing.

Using Total Count

The x-total-count header is useful for:

  • Implementing pagination UI (e.g., showing “Page 1 of 10”)
  • Determining if there are more records to fetch
  • Showing total result counts to users

Common Query Parameters

Pagination

  • page: The page number to retrieve (starts at 1)
  • limit: Number of items per page

Example:

GET /properties?page=2&limit=10

Filtering

Use the filter parameter to narrow down results:

GET /properties?filter=status=active

Sorting

Use the sort parameter to order results:

GET /properties?sort=createdAt:desc

Relations

To include related data in the response, use the fields parameter with dot notation to specify the relations:

GET /households?fields=property.*,documents.*

The asterisk (*) will fetch all fields from the related entity. You can also specify particular fields:

GET /households?fields=id,name,property.name,property.address

Multiple relations can be requested in the same query:

GET /households?fields=id,name,property.*,documents.type,tenants.name

Response Formats

All API responses follow a consistent JSON format:

Example Request and Response

$curl -i -X GET https://api.fortresstech.io/v1/users
>HTTP/1.1 200 OK
>x-total-count: 9211
>Content-Type: application/json; charset=utf-8
>Content-Length: 3206
>Date: Mon, 09 Jun 2025 19:46:10 GMT
>
>[
>  {
>    "id": "123e4567-e89b-12d3-a456-426614174000",
>    "firstname": "John",
>    "lastname": "Smith",
>    "email": "john.smith@example.com",
>    "status": "ACTIVE"
>  }
>]

Example API Error Response

$curl -i -X GET https://api.fortresstech.io/v1/users/12
>HTTP/1.1 400 Bad Request
>Content-Type: application/json; charset=utf-8
>Content-Length: 40
>Vary: Accept-Encoding
>Date: Mon, 09 Jun 2025 19:46:54 GMT
>
>{"message":"Invalid UUID parameter: 12"}