Connections

Overview

GET /connections

Retrieves the list of all connections configured within your account. A connection is the link between one of your telematics provider accounts and Manifold. Each connection has its provider and its health status, so you can monitor your integrations.

The list is not paginated: every connection of your account is returned at once. The response carries the id of each connection, which is the Connection-Id you send to most other endpoints.

Request details

Headers

This endpoint does not use the Connection-Id header, and takes no query parameters.

Response

{
  "status": 200,
  "message": null,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Fleet Management Connection 1",
      "providerId": "456e1234-e89b-12d3-a456-426614174111",
      "healthStatus": 2,
      "createdAt": "2024-10-13T15:28:33.692Z"
    }
  ],
  "next": null
}

Response field explanations

Top-level fields

• status: Integer code indicating the request status (200 means success)
• message: Additional details, or null
• data: The list of connections
• next: Always null: this list has only one page

Connection object fields

• id: Unique ID of the connection
• name: Human-readable name of the connection
• providerId: ID of the telematics provider of the connection
• healthStatus: The state of the connection:
  • 1: Created (the connection has been set up and not yet validated)
  • 2: Validated (the credentials were checked and the connection is working)
  • 3: Failed (the connection could not be validated or stopped working)
  • 4: Duplicated (the same provider account is connected twice)
• createdAt: When the connection was created

Health status details

Example request

curl --request GET \
  --url "https://api.analytics.autos/connections" \
  --header 'x-api-key: YOUR-API-KEY'

Common use cases

• Finding the Connection-Id to use in other requests
• Auditing connected telematics providers
• Monitoring integration health

Best practices

• Call this endpoint first, and use the ids it returns as the Connection-Id of the other endpoints
• Check the health status of your connections regularly
• Store and rotate API keys securely