Your account holds customers (your customers' businesses) and their fleets (tracking accounts). Devices, services and tracking data belong to a fleet. A customer can have several fleets, for example one per plan or per depot.
| Endpoint | Purpose | Scope |
|---|---|---|
GET /customers | List customers. Filters: external_reference, status. | customers.read |
POST /customers | Create a customer (name, optional external_reference, contact details). | customers.write |
GET /customers/{id} · PATCH /customers/{id} | Read or update a customer. | customers.read · customers.write |
GET /fleets | List fleets. Filters: customer_id, external_reference, status. | fleets.read |
POST /fleets | Create a fleet (customer_id, name, plan_code, optional external_reference, timezone). Provisioning starts at once. | fleets.write |
GET /fleets/{id} · PATCH /fleets/{id} | Read or update a fleet's name, reference and timezone. | fleets.read · fleets.write |
POST /fleets/{id}/plan-changes | Change the plan of every service in the fleet (plan_code, expected_affected_services); 202 with an operation. | services.activate |
POST /fleets/{id}/invitations | Invite one of your customer's users to a Fleetalyse-hosted tracking login (only when hosted access is enabled for your account). | fleets.write |
Find by your own reference
external_reference is unique per partner and mode (case-sensitive). Resolve "my customer C1042" with GET /customers?external_reference=C1042 instead of storing only our ids — that is how a retry after a lost response finds the record it already created.
Fleet states
| Status | Meaning |
|---|---|
pending / provisioning | Being set up on the tracking platform. Activations wait for it. |
ready | Usable. Event fleet.ready (and customer.ready for a customer's first fleet). |
provisioning_failed | Setup failed; see the operation and contact support. Event fleet.provisioning_failed. |
closed | No longer used. |
Plans are per fleet
The plan (for example basic or pro) is a property of the fleet. To mix plans for one customer, use two fleets. See Plans & capabilities.
Customers are never deleted through the API — cancelling services and closing fleets keeps your usage history and invoices intact.