Skip to content
TLGPSDocumentation

Developer documentation

REST API / V1

Companies

REST API V1 resources, authentication and bounded reads.

Companies represent fleet owners or customer organizations within the Fleet Management System. The authenticated user only receives companies they are authorized to access.


Company Object

Field Type Description
uuid UUID Unique company identifier
name string Company name
vehicles_count integer Number of vehicles belonging to the company

Example:

{
    "uuid": "01900000-0000-7000-8000-000000000002",
    "name": "Northstar Fleet Operations",
    "vehicles_count": 82
}

List Companies

Returns a paginated collection of companies visible to the authenticated user.

Endpoint

GET https://api.tlgps.athear.ly/v1/companies
Authorization: Bearer <token>
Accept: application/json

Query Parameters

This endpoint currently does not support filtering.


Example:

GET https://api.tlgps.athear.ly/v1/companies
Authorization: Bearer <token>
Accept: application/json

Successful Response

{
    "data": [
        {
            "uuid": "01900000-0000-7000-8000-000000000002",
            "name": "Northstar Fleet Operations",
            "vehicles_count": 82
        },
        {
            "uuid": "01900000-0000-7000-8000-000000000003",
            "name": "Example Fleet Company",
            "vehicles_count": 154
        }
    ],
    "links": {
        "first": "https://api.tlgps.athear.ly/v1/companies?page=1",
        "last": "https://api.tlgps.athear.ly/v1/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 15,
        "total": 2
    }
}

Response Fields

Field Type Description
data array Collection of Company objects
links object Pagination links
meta object Pagination metadata

Get Company

Returns a single company visible to the authenticated user.

Endpoint

GET https://api.tlgps.athear.ly/v1/companies/{company}
authorization: bearer <access-token>
accept: application/json

Path Parameters

Parameter Type Description
company UUID Company UUID

Note

Resources are resolved by uuid rather than numeric identifiers.


Example:

GET https://api.tlgps.athear.ly/v1/companies/01900000-0000-7000-8000-000000000002
Authorization: Bearer <token>
Accept: application/json

Successful Response

{
    "data": {
        "uuid": "01900000-0000-7000-8000-000000000002",
        "name": "Northstar Fleet Operations",
        "vehicles_count": 82
    }
}

Possible Responses

Status Description
200 Company returned successfully
401 Authentication required
403 Token lacks required ability
404 Company not found or not visible to the authenticated user

Note

  • Only companies visible to the authenticated user are returned.
  • Company UUIDs are immutable.
  • vehicles_count reflects the number of vehicles currently associated with the company.

Public documentation · authorized integration access required

Engineering-maintained documentation. Examples use synthetic data and placeholder credentials.

Back to top