> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://catena.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://catena.ferndocs.com/_mcp/server.

# 🧪 List Vehicle Region Segments

GET https://api.catenatelematics.com/v2/telematics/vehicle-region-segments

List region segment aggregates visible to the authenticated organization.

Reference: https://catena.ferndocs.com/api-reference/telematics/fleet-operations-tracking/list-vehicle-region-segments

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `group_by` ("segment", optional, nullable) — Optional grouping mode. Use `segment` to collapse repeated visits to the same region for a vehicle within the filtered window, using the min start time and max end time.
- `include_vehicle` (boolean, optional, default: false) — If true, each segment will include a `vehicle` object with basic vehicle information. Segments without a matching vehicle will have `vehicle` set to null.
- `fleet_ids` (list of string, optional, nullable) — Limit results to specific fleets using Catena's fleet IDs. *For your own fleet identifiers, use `fleet_refs` instead* To specify multiple values, repeat the parameter for each value (e.g., `?fleet_ids=id1&fleet_ids=id2`).
- `fleet_refs` (list of string, optional, nullable) — Limit results to specific fleets using your organization's fleet reference identifiers. To specify multiple values, repeat the parameter for each value (e.g., `?fleet_refs=ref1&fleet_refs=ref2`).
- `connection_id` (string, optional, nullable) — Limit results to a specific provider connection. This is the UUID assigned by Catena when your fleet connects to a TSP.
- `from_date` (date, optional) — Return only records with a processing date on or after this date. **Format:** YYYY-MM-DD **Applies filter:** `processing_date >= from_date` **Default value:** yesterday **Restriction:** `to_date - from_date` cannot exceed 180 days
- `to_date` (date, optional) — Return only records with a processing date on or before this date. **Format:** YYYY-MM-DD **Applies filter:** `processing_date <= to_date` **Default value:** today **Restriction:** `to_date - from_date` cannot exceed 180 days
- `vehicle_ids` (list of string, optional, nullable) — Limit results to specific vehicles. **Maximum:** 100 IDs To specify multiple values, repeat the parameter for each value (e.g., `?vehicle_ids=id1&vehicle_ids=id2`).
- `country_code` (string, optional, nullable) — Limit results to a specific country using its ISO 3166-1 alpha-3 code (e.g., `USA`, `CAN`).
- `region` (string, optional, nullable) — Limit results to a specific region or state within the country (e.g., `TX`, `ON`).
- `cursor` (string, optional, nullable) — Cursor for the next page
- `size` (integer, optional, default: 300) — Page size

## Response

### 200

Successful Response

- `items` (list of VehicleRegionSegmentRead, required)
- `total` (integer, required)
- `current_page` (string, optional, nullable) — Cursor to refetch the current page
- `current_page_backwards` (string, optional, nullable) — Cursor to refetch the current page starting from the last item
- `previous_page` (string, optional, nullable) — Cursor for the previous page
- `next_page` (string, optional, nullable) — Cursor for the next page

## Errors

### 400 Bad Request Error

Bad Request

- `code` (integer, optional, default: 400)
- `message` (string, optional, default: Bad Request)
- `detail` (string, optional, nullable)

### 401 Unauthorized Error

Unauthorized

- `code` (integer, optional, default: 401)
- `message` (string, optional, default: Unauthorized)
- `detail` (string, optional, nullable)

### 403 Forbidden Error

Forbidden

- `code` (integer, optional, default: 403)
- `message` (string, optional, default: Forbidden)
- `detail` (string, optional, nullable)

### 404 Not Found Error

Not Found

- `code` (integer, optional, default: 404)
- `message` (string, optional, default: Not Found)
- `detail` (string, optional, nullable)

### 405 Method Not Allowed Error

Method Not Allowed

- `code` (integer, optional, default: 405)
- `message` (string, optional, default: Method Not Allowed)
- `detail` (string, optional, nullable)

### 409 Conflict Error

Conflict

- `code` (integer, optional, default: 409)
- `message` (string, optional, default: Conflict)
- `detail` (string, optional, nullable)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `code` (integer, optional, default: 422)
- `message` (string, optional, default: Invalid Request Body)
- `detail` (list of ValidationErrorDetail, optional, nullable)

### 429 Too Many Requests Error

Too Many Requests

- `code` (integer, optional, default: 429)
- `message` (string, optional, default: Too Many Requests)
- `detail` (RetryAfterDetail, optional, nullable)

### 500 Internal Server Error

Internal Server Error

- `message` (string, optional, default: Internal Server Error)

### 501 Not Implemented Error

Not Implemented

- `code` (integer, optional, default: 501)
- `message` (string, optional, default: Not Implemented)
- `detail` (string, optional, nullable)

## Types

### VehicleRegionSegmentRead

API/read model for IFTA region segments a vehicle entered during a specific UTC day (00:00 to 00:00 UTC).

- `fleet_id` (string, required, nullable) — Internal fleet identifier.
- `id` (string, required) — Unique identifier of the record at Catena Telematics.
- `created_at` (datetime, required) — Immutable: The datetime the record was ingested into Catena Telematics.
- `updated_at` (datetime, required) — The dateime the record was last modified in Catena Telematics.
- `connection_id` (string, required) — Unique identifier of the connection at Catena Telematics through which this record was ingested. A connection represents a Fleet/TSP pairing.
- `processing_date` (date, required) — UTC day for which the region segments are listed, bounded from 00:00 to 00:00 UTC.
- `vehicle_id` (string, required) — Internal vehicle identifier (Catena FK).
- `segment_start_time` (datetime, required) — UTC timestamp of the first location sample in the segment.
- `segment_end_time` (datetime, required) — UTC timestamp of the last location sample in the segment.
- `location_count` (integer, required) — Number of location samples that belong to the segment.
- `fleet_ref` (string, optional, nullable) — External fleet reference in the partner system.
- `deleted_at` (datetime, optional, nullable) — The datetime the record was logically deleted from Catena Telematics.
- `driver_id` (string, optional, nullable) — Internal driver identifier associated with the segment, if available.
- `country_code` (string, optional, nullable) — ISO-3166-1 alpha-3 country code inferred for the segment.
- `region` (string, optional, nullable) — Region code inferred for the segment, typically a state or province in IFTA contexts.
- `odometer_start` (double, optional, nullable) — Odometer reading at the start of the segment (SI units from source system).
- `odometer_end` (double, optional, nullable) — Odometer reading at the end of the segment (SI units from source system).
- `distance` (double, optional, nullable) — Distance traveled during the segment, derived from odometer delta (SI units).
- `odometer_start_unit` (enum, optional) — Unit for odometer_start.
  - Allowed values: `m`, `km`, `mi`, `ft`, `nmi`
- `odometer_end_unit` (enum, optional) — Unit for odometer_end.
  - Allowed values: `m`, `km`, `mi`, `ft`, `nmi`
- `distance_unit` (enum, optional) — Unit for distance.
  - Allowed values: `m`, `km`, `mi`, `ft`, `nmi`
- `vehicle` (VehicleEmbeddedRead, optional, nullable) — Basic vehicle information. Only populated when `include_vehicle=true` is requested.

### ValidationErrorDetail

- `path` (string, required)
- `input` (string, required)
- `message` (string, required)
- `error_type` (string, required)

### RetryAfterDetail

- `retry_after_seconds` (integer, required)
- `message` (string, required)

### VehicleEmbeddedRead

Lightweight vehicle snapshot embedded in other API responses.

- `id` (string, required) — Unique identifier of the record at Catena Telematics.
- `vehicle_name` (string, optional, nullable) — Display name or unit number for the vehicle.
- `model_type` (string, optional, nullable) — Manufacturer model or type designation (e.g., 'Class 8 Tractor', 'Pickup').
- `model_year` (integer, optional, nullable) — Model year (four-digit, e.g., 2022).
- `vin` (string, optional, nullable) — Vehicle Identification Number (VIN), typically 17 characters; if available.
- `license_plate_region` (string, optional, nullable) — Plate region/subdivision (state/province code, e.g., 'CA', 'ON').
- `license_plate_country` (string, optional, nullable) — Plate country code (ISO-3166-1 alpha-3, e.g., 'USA', 'CAN').
- `license_plate_number` (string, optional, nullable) — License plate number (e.g., 'HMT-3570').
- `eld_id` (string, optional, nullable) — Telematics/ELD device identifier associated with this vehicle, if any.
- `eld_serial_number` (string, optional, nullable) — Telematics/ELD device serial number, if any.
- `source_id` (string, optional, nullable) — Unique identifier of the record in the TSP.
- `external_id` (string, optional, nullable) — External vehicle identifier as known in the TSP or customer's system.

## Examples

**Response**

```json
{
  "items": [
    {
      "fleet_id": "string",
      "id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "connection_id": "string",
      "processing_date": "2023-01-15",
      "vehicle_id": "string",
      "segment_start_time": "2024-01-15T09:30:00Z",
      "segment_end_time": "2024-01-15T09:30:00Z",
      "location_count": 1,
      "fleet_ref": "string",
      "deleted_at": "2024-01-15T09:30:00Z",
      "driver_id": "string",
      "country_code": "string",
      "region": "string",
      "odometer_start": 1.1,
      "odometer_end": 1.1,
      "distance": 1.1,
      "odometer_start_unit": "m",
      "odometer_end_unit": "m",
      "distance_unit": "m",
      "vehicle": {
        "id": "string",
        "vehicle_name": "string",
        "model_type": "string",
        "model_year": 1,
        "vin": "string",
        "license_plate_region": "string",
        "license_plate_country": "string",
        "license_plate_number": "string",
        "eld_id": "string",
        "eld_serial_number": "string",
        "source_id": "string",
        "external_id": "string"
      }
    }
  ],
  "total": 1,
  "current_page": "string",
  "current_page_backwards": "string",
  "previous_page": "string",
  "next_page": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.catenatelematics.com/v2/telematics/vehicle-region-segments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.catenatelematics.com/v2/telematics/vehicle-region-segments';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.catenatelematics.com/v2/telematics/vehicle-region-segments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.catenatelematics.com/v2/telematics/vehicle-region-segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.catenatelematics.com/v2/telematics/vehicle-region-segments")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.catenatelematics.com/v2/telematics/vehicle-region-segments', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.catenatelematics.com/v2/telematics/vehicle-region-segments");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.catenatelematics.com/v2/telematics/vehicle-region-segments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```