Upper Crew API

A REST API for developers and automation tools to programmatically manage routes, stops, drivers, and webhooks in Upper Crew.

The Upper Crew external API lets you build integrations and automations directly on top of your Upper Crew account. Use it to create and optimize route plans, manage stops and drivers, sync custom field data, and receive real-time event notifications via webhooks — all without touching the Upper Crew web app.

It is intended for developers building internal tools or third-party integrations, and for automation platforms (such as Zapier or n8n) that need to push and pull data from Upper Crew programmatically.

You need an API token before you can make any requests. Get yours in the app under Settings → Webhooks, then see Authentication for how to include it in every call.

What you can do

The API covers the core objects in Upper Crew:

Routes — create route plans, add stops in bulk, and trigger optimization. See Routes.
Stops — create, update, and look up individual stops. See Stops.
Drivers — list and look up driver records. See Drivers.
Custom and capacity fields — read and write the custom stop fields and vehicle capacity values configured in your workspace. See Custom and Capacity Fields.
Webhooks — subscribe to real-time events (for example, stop completed or route dispatched) so your systems stay in sync without polling. See Webhooks.

Base URL and conventions

All API endpoints share the same base URL:

https://teamapi.upperinc.com/api/v1

Response envelope

Every endpoint returns a consistent JSON envelope:

{
  "code": 200,
  "message": "Success.",
  "data": {}
}

Field	Type	Description
`code`	integer	HTTP-equivalent status code for the operation
`message`	string	Human-readable result description
`data`	object or array	The returned payload; empty array `[]` when there is nothing to return

Authentication

Every request to an ext-* endpoint must include your API token as an HTTP header:

x-api-token: <your-token>

Omitting the header returns HTTP 400 with "Token is required."; an unrecognised token returns HTTP 401 with "User not found." See Authentication for the full details and error reference.

Connect without code

If you prefer a no-code or low-code approach, Upper Crew works with popular automation platforms out of the box:

Zapier — connect Upper Crew to thousands of apps using pre-built Zaps. See Connect with Zapier.
n8n — build visual automation workflows that read and write Upper Crew data. See Connect with n8n.