> ## Documentation Index
> Fetch the complete documentation index at: https://withforerunner.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API conventions

> Common patterns for all API endpoints

## Request headers

All API requests require authentication and may require a content type header
depending on the endpoint.

### Authorization

Every request must include your API key in the Authorization header:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

See [Authentication](/docs/developers/v1/authentication) for how to obtain and manage
your API key.

### Content-Type

For endpoints that accept a request body:

| Body type | Content-Type header |
| - | - |
| JSON data | `application/json` |
| File uploads | `multipart/form-data` |

`POST /api/v1/files` is the only endpoint that takes `multipart/form-data`, and it rejects a JSON body. GET and DELETE requests don't need a `Content-Type` header.

## Response format

All responses are JSON objects. Each one carries an `errors` array plus the resource keys for that endpoint: `files`, `file`, `properties`, `records`, `record`, `sisd`, `property`, or `upload`. Deleting a record returns `errors` alone.

## Errors

An error entry names the problem and the request field that caused it:

```json theme={null}
{
  "errors": [
    { "message": "Invalid UUID format for id parameter", "field": "id" }
  ]
}
```

See [Errors](/docs/developers/v1/errors) for the full status code table, the firewall `403`, rate limits, and what is safe to retry.

## Pagination

List endpoints return 25 results per page. The page size is fixed. Use the `page` query parameter to navigate:

```bash theme={null}
GET /api/v1/properties?page=2
```

Sample response:

```json theme={null}
{
  "errors": [],
  "properties": [...],
  "pageInfo": {
    "page": 2,
    "pageSize": 25,
    "totalCount": 250,
    "totalPages": 10
  }
}
```

`pageInfo` is present on a successful list response and omitted when the request failed validation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.