Get Mismatch Alerts

Lists trailer mismatch observation alerts for the authenticated customer.

Authentication

• Include your Access-Token and x-api-key in the header of your requests.

Permissions

The external-api-mismatch-observations or admin permission is required to access this endpoint.

Endpoint

• URL: https://api.genlogs.io/mismatch-observations

• Method: GET

Headers

• Access-Token: (string, required): Access token obtained from the "Create Access Token" endpoint.

• x-api-key (string, required): The API key provided by GenLogs.

Request Example:

curl --location 'https://api.genlogs.io/mismatch-observations?page=1&page_size=5' \
--header 'access-token: <your-api-token>' \
--header 'x-api-key: <your-x-api-key>'

Response:

• 200 OK: A JSON object containing the list of paginated trailer mismatch alerts.

• 400 Bad Request: If one of the provided parameters is incorrect.

• 401 Unauthorized: If the authentication credentials (Access-Token) is missing or incorrect.

• 403 Forbidden: If the permission has not been set to your user.

• 500 Internal Server Error: If there is an issue on the server that prevents processing the request.

Response Body:

200 OK

• mismatch_observations (list): list of trailer mismatch observations including related information.

  • id (str, UUID): unique identifier of the alert.

  • name (str, optional, nullable): alert display name. If not provided when the alert is created, it is set to null.

  • usdot (str, nullable): USDOT value associated with the mismatch observation. null when not applicable.

  • mc (str, nullable): MC value associated with the mismatch observation. null when not applicable.

  • is_disabled (bool): indicates whether the mismatch alert is disabled.

  • created_at (str, date-time): creation timestamp in ISO-8601 format.

  • last_run_at (str, date-time, nullable): last run timestamp in ISO-8601 format.

• page (int): current page number (1-based).

• page_size (int): number of items returned per page.

• total (int): total number of mismatch observations available for the customer.

{
    "mismatch_observations": [
        {
            "id": "b9291b70-2383-4e5d-9f33-ecd5808b96a2",
            "name": null,
            "usdot": null,
            "mc": "300000",
            "is_disabled": false,
            "created_at": "2026-04-07T22:30:02.608190",
            "last_run_at": null
        },
        {
            "id": "3145720d-4c09-440b-89da-616d3b9adb4c",
            "name": "mismatch alert mc 4000",
            "usdot": null,
            "mc": "4000",
            "is_disabled": true,
            "created_at": "2026-04-07T22:29:54.563299",
            "last_run_at": null
        }
    ],
    "page": 1,
    "page_size": 2,
    "total": 10
}

400 Bad Request

{
    "message": "Invalid request parameters: 'page_size'",
    "error_code": "VALIDATION_ERROR"
}

401 Forbidden

{
  "detail": {
    "message": "Token is missing",
    "subcode": "TOKEN_MISSING"
  }
}

403 Forbidden

{
    "detail": "User does not have the required permissions to access this resource"
}

List mismatch observations

get

Returns mismatch observations for the authenticated customer only, ordered from newest to oldest. Paginated; default page size is 50. Returns 200 with an empty mismatch_observations array when none exist.

Authorizations

Access-Token & X-Api-Key

Access-TokenstringRequired

x-api-keystringRequired

Query parameters

pageinteger · min: 1Optional

Page number (1-based).

Default: 1

page_sizeinteger · min: 1 · max: 500Optional

Number of items per page (max 500).

Default: 50

Responses

200

Paginated list of mismatch observations for the customer.

application/json

pageinteger · min: 1Required

Current page number.

page_sizeinteger · min: 1 · max: 500Required

Page size used for this response.

totalintegerRequired

Total number of observations for this customer (all pages).

401

Unauthorized – Invalid or missing Access-Token.

403

Forbidden – missing permission.

get

/mismatch-observations

HTTPcURLJavaScriptPython

GET /mismatch-observations HTTP/1.1
Host: api.genlogs.io
Access-Token: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Accept: */*

{
  "mismatch_observations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "alert_name": "Weekly mismatch watch",
      "usdot": "1234567",
      "mc": null,
      "logos": [
        "AMX",
        "Utility"
      ],
      "is_disabled": false,
      "created_at": "2025-01-15T12:00:00Z",
      "last_run_at": null
    }
  ],
  "page": 1,
  "page_size": 50,
  "total": 1
}