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

# Alert configurations

> Paginated list of alert definitions for the company and its sub-companies.

### Overview

Returns alert configuration records (definitions, not triggered events) for the company and its sub-companies. Each record includes the `alertType` discriminator (a numeric string), a human-readable `alertName`, the vehicles or tags the alert monitors, and whether it applies to the whole fleet.

This is a **new V2-only endpoint** with no V1 equivalent.

<Note>**Rate limit:** 4 req/s · 20/min · 600/hr · 14,400/day</Note>

### Endpoint

`GET /v2/api/companies/{id}/alerts`

### Path parameters

<ParamField path="id" type="integer" required>
  Company ID.
</ParamField>

### Query parameters

<ParamField query="page" type="integer" default="1">
  Page number (1-based).
</ParamField>

<ParamField query="pageSize" type="integer" default="50">
  Records per page.
</ParamField>

### Response

**200 OK** — `PagedListResult<AlertConfigDto>`

| Field            | Type      | Description                                                                                                                 |
| ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
| alertId          | integer   | Alert definition ID — use this when linking to webhooks                                                                     |
| alertType        | string    | Numeric string identifying the alert type (e.g. `"18"`). Use `alertName` and `alertDescription` for human-readable context. |
| companyId        | integer   | Company the alert belongs to                                                                                                |
| alertName        | string    | Alert name from the latest snapshot                                                                                         |
| alertDescription | string    | Alert description from the latest snapshot                                                                                  |
| isAllFleet       | boolean   | `true` if the alert applies to all vehicles in the company                                                                  |
| isAllTags        | boolean   | `true` if the alert applies to all tags in the company                                                                      |
| units            | array     | Vehicles explicitly monitored (see below) — empty when `isAllFleet` is `true`                                               |
| tags             | string\[] | Tags monitored — empty when `isAllTags` is `true`                                                                           |

`Units` items:

| Field     | Type            | Description          |
| --------- | --------------- | -------------------- |
| vehicleId | integer \| null | Vehicle ID           |
| name      | string          | Vehicle display name |
| imei      | string \| null  | Device IMEI          |
| vin       | string \| null  | Vehicle VIN          |

### Example response

```json theme={null}
{
  "items": [
    {
      "alertId": 101,
      "alertType": "18",
      "companyId": 12,
      "alertName": "Highway speeding",
      "alertDescription": "Speed over 110 km/h on highway zones",
      "isAllFleet": true,
      "isAllTags": false,
      "units": [],
      "tags": []
    }
  ],
  "currentPage": 1,
  "numberOfPages": 1,
  "totalResults": 1,
  "lastResultIndex": 0
}
```

### Error responses

| Status | Meaning                                                   |
| ------ | --------------------------------------------------------- |
| 401    | Missing or invalid token                                  |
| 404    | Company not found or not in caller's accessible hierarchy |

```bash theme={null}
curl "https://api.telemax.com.au/v2/api/companies/12/alerts?page=1&pageSize=50" \
  -H "Authorization: Bearer <token>"
```


## OpenAPI

````yaml openapi.yaml GET /v2/api/companies/{id}/alerts
openapi: 3.1.0
info:
  title: Telemax External API (V2)
  version: '2026-04-14'
  description: >
    Telemax External API — fleet telemetry, vehicle commands, and integrations.


    **Base URL:** `https://api.telemax.com.au`


    **Authentication:** All routes require a `Bearer` JWT unless marked
    `[AllowAnonymous]`.

    Obtain tokens via `POST /v2/api/authentication/token/api-key`.


    **RESTful architecture:** V2 uses standard HTTP methods (GET, POST, PUT,
    DELETE) with

    resource-based routes and consistent pagination via `page` and `pageSize`
    query parameters.


    **API versioning:** All responses will include an `X-API-Version` header
    containing the

    date-based version string (e.g. `2026-04-28`). See the
    [Changelog](/v2/changelog) for

    the deprecation policy and version history.


    For full documentation including error handling, pagination, and known field
    quirks, see [docs.telemax.com.au](https://docs.telemax.com.au).
servers:
  - url: https://api.telemax.com.au
security:
  - BearerAuth: []
paths:
  /v2/api/companies/{id}/alerts:
    get:
      summary: Alert configurations (V2)
      description: >-
        Paginated list of alert definitions for the company and its
        sub-companies.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          example: 12
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: pageSize
          in: query
          schema:
            type: integer
            default: 50
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              example:
                items:
                  - alertId: 3631
                    alertType: '18'
                    companyId: 997
                    alertName: Service Reminder Overdue
                    alertDescription: 862406071450635 [Mileage reminder test] is overdue.
                    isAllFleet: false
                    isAllTags: false
                    units:
                      - vehicleId: 22259
                        name: Fleet Vehicle 01
                        imei: '862406071450635'
                        vin: MPBCMFF70RX582825
                    tags: []
                totalResults: 9
                lastResultIndex: 2
                currentPage: 1
                numberOfPages: 5
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: >-
            **404 Not Found** — The requested company does not exist or is not
            accessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                type: RESOURCE
                code: NOT_FOUND
                description: Company was not found.
                requestId: 0HNLTALNU4DD4:00000002
                docUrl: https://docs.telemax.com.au/errors/not-found
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: >
        **401 Unauthorized** — JWT is missing, expired, or malformed.

        The JWT bearer middleware rejects the request before it reaches the
        controller.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: AUTHENTICATION
            code: INVALID_CREDENTIALS
            description: The provided API key is invalid or does not exist.
            requestId: 0HNLTALNU4DCO:00000004
            docUrl: https://docs.telemax.com.au/errors/invalid-credentials
    TooManyRequests:
      description: >
        **429 Too Many Requests** — Rate limit exceeded. Check the Retry-After
        header for the number of seconds to wait before retrying.

        Use exponential backoff: wait Retry-After seconds, then double the
        interval on each subsequent 429.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: RATE_LIMIT
            code: RATE_LIMIT_EXCEEDED
            description: Too many requests. Please slow down.
            requestId: req_6d2f8b4a
            docUrl: https://docs.telemax.com.au/errors/rate-limit-exceeded
    InternalServerError:
      description: >
        **500 Internal Server Error** — An unexpected error occurred. Include
        the requestId when contacting support.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: SERVER_ERROR
            code: INTERNAL_SERVER_ERROR
            description: An unexpected error occurred. Please try again later.
            requestId: req_1e5a3c7d
            docUrl: https://docs.telemax.com.au/errors/internal-server-error
  schemas:
    ApiError:
      type: object
      description: Standard error response returned by all API endpoints.
      properties:
        type:
          type: string
          description: >-
            Error category (e.g. AUTHENTICATION, AUTHORIZATION, RESOURCE,
            VALIDATION_ERROR, RATE_LIMIT, SERVER_ERROR).
          example: AUTHENTICATION
        code:
          type: string
          description: Machine-readable error code within the category.
          example: INVALID_CREDENTIALS
        description:
          type: string
          description: Human-readable explanation of the error and how to resolve it.
          example: The provided API key is invalid or does not exist.
        requestId:
          type: string
          description: Unique request identifier for support correlation.
          example: req_7f3a2b1c
        docUrl:
          type: string
          format: uri
          description: Link to the relevant error documentation page.
          example: https://docs.telemax.com.au/errors/invalid-credentials
      required:
        - type
        - code
        - description
  headers:
    X-RateLimit-Limit:
      description: >-
        Maximum number of requests allowed per minute for this token. **Not yet
        active** — this header will be added once the rate-limit middleware is
        deployed. See the [Changelog](/v2/changelog) for the rollout date.
      schema:
        type: integer
        example: 60
    X-RateLimit-Remaining:
      description: >-
        Number of requests remaining in the current rate limit window. **Not yet
        active** — see `X-RateLimit-Limit`.
      schema:
        type: integer
        example: 47
    X-RateLimit-Reset:
      description: >-
        Unix timestamp (seconds) at which the current rate limit window resets.
        **Not yet active** — see `X-RateLimit-Limit`.
      schema:
        type: integer
        example: 1746000060
    Retry-After:
      description: Number of seconds to wait before retrying after a 429 response.
      schema:
        type: integer
        example: 30
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token obtained from `POST
        /v2/api/authentication/token/api-key`.


        **Lifetime:** ~24 hours (86,399 seconds). Cache the token and reuse it.
        Re-authenticate 5 minutes before expiry.


        **Scoping:** API key tokens are scoped to the company the key belongs to
        and may restrict

        access to a vehicle allowlist and/or action set (see token claims).


        **No refresh endpoint** — re-authenticate with your API key when the
        token expires.

````