Augment API
REST API to manage freight loads and route stops, upsert and archive carriers, post tracking events, report carrier issues, and configure webhook endpoints and event subscriptions. OpenAPI 3.1, HTTP Basic auth (API key as password).
OpenAPI Specification
{
"openapi": "3.1.1",
"info": {
"title": "Augment API",
"description": "<a href=\"https://trust.goaugment.com/?utm_campaign=api_docs&utm_source=api_docs&utm_medium=api_docs&utm_content=api_docs\" target=\"_blank\">Augment is now SOC 2 Type II Certified</a>\n\nThe Augment API endpoints are calls your system makes to manage loads,\ncarriers, and webhook configuration.\nThe latest version of the Augment API is hosted [online](https://apidocs.goaugment.com).\n\n## API Endpoints\n\nEndpoints your system calls to interact with Augment:\n\n- [Load Management](/reference/tag/load-management)\n- [Carrier Management](/reference/tag/carrier-management)\n- [Models](/reference/models)\n- [Webhook Endpoints](/reference/tag/webhook-endpoints)\n- [Webhook Event Subscriptions](/reference/tag/webhook-event-subscriptions)\n\nWebhook management access is gated. Request access from Augment before using\nthese endpoints. After access is enabled, you can self-manage the webhook\nendpoints that receive event payloads and the webhook event subscriptions\nthat control which events are sent to each endpoint.\n\nUse [Webhook Endpoints](/reference/tag/webhook-endpoints) to create and\nupdate the HTTPS destinations where Augment sends webhook payloads. Use\n[Webhook Event Subscriptions](/reference/tag/webhook-event-subscriptions) to\nchoose event types for each endpoint and send test deliveries.\n\nOutbound webhook payloads, including Track & Trace events, are documented\nseparately in the [Webhooks](/webhooks) reference. Subscriptions created\nthrough the public webhook management APIs deliver version 2 webhook payloads only.\n\n## Resources\n\n* [Homepage](https://www.goaugment.com)\n* [LinkedIn](https://www.linkedin.com/company/goaugment)\n* [Jobs - we're hiring!](https://jobs.ashbyhq.com/go-augment?utm_source=AMy24qx30n)\n\n## Developer Notes\n\nAll date-time fields are represented as strings. The date-time notation is defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6). Examples:\n- `2025-08-21T12:34:56Z`\n- `2025-08-21T04:34:56-08:00`\n\nHowever, when using local time, do not include the trailing `Z` or timezone offset in the date-time string.\n\nExample:\n- `2025-08-21T12:34:56`\n",
"version": "20.0.1"
},
"servers": [
{
"url": "https://api.prod.goaugment.com"
}
],
"security": [
{
"httpBasic": []
}
],
"tags": [
{
"name": "API Key",
"description": "API key based authorization. Please refer to the\n[authorization documentation](docs/authorization.md) for details.\n"
},
{
"name": "Load Management",
"description": "API endpoints for creating, updating, and retrieving loads.\n"
},
{
"name": "Carrier Management",
"description": "API endpoints for managing carriers, carrier contacts, and carrier-manager relationships.\n"
},
{
"name": "Carrier Support",
"description": "Public API endpoints for correlating carrier issues (detention, lumper, TONU, etc.) with the matching incidents in your TMS. Access is gated by brokerage; talk to Augment before using these endpoints.\n"
},
{
"name": "Webhook Endpoints",
"description": "Public API endpoints for approved brokerages to create, update, list, and delete webhook endpoints. Self-service endpoints send version 2 webhook payloads only. Access is gated by brokerage; talk to Augment before using these endpoints.\n"
},
{
"name": "Webhook Event Subscriptions",
"description": "Public API endpoints for approved brokerages to list supported webhook event types, subscribe endpoints to event types, and send test deliveries. Subscriptions created through these public APIs deliver version 2 webhook event shapes only. Access is gated by brokerage; talk to Augment before using these endpoints.\n"
}
],
"paths": {
"/v2/auth-check": {
"post": {
"operationId": "verifyApiKey",
"security": [
{
"httpBasic": []
}
],
"tags": [
"API Key"
],
"summary": "Verify your API key",
"description": "Verify your API key is valid and not revoked. Use our auth check endpoint to verify your API key without writing data to your account. Great for setup and troubleshooting, but not intended for automated production health checks.\n",
"responses": {
"200": {
"description": "API key is verified",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthCheckError"
}
}
}
}
}
}
},
"/v2/loads": {
"get": {
"operationId": "getLoad",
"tags": [
"Load Management"
],
"summary": "Get load by load number",
"description": "Retrieve enriched load data by load number (brokerage load ID). Returns the full LoadV2 format including carrier details, tracking events, reference numbers, notes, subscribers, and shipment information.\n",
"parameters": [
{
"name": "loadNumber",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The load number (brokerage load ID)",
"example": "LOAD-12345"
}
],
"responses": {
"200": {
"description": "Load found and returned successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoadV2Response"
}
}
}
},
"400": {
"description": "Bad request - loadNumber query parameter is required",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"404": {
"description": "Load not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
},
"post": {
"operationId": "createOrUpdateLoad",
"tags": [
"Load Management"
],
"summary": "Create or update load",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoadRequest"
},
"example": {
"brokerage": {},
"load": {
"loadNumber": "1",
"mode": "FTL",
"status": "DRAFT",
"isPostedToDAT": false,
"route": [
{
"sequence": 1,
"stopActivity": "PICKUP",
"expectedArrivalWindowStart": "2025-09-01T12:00:00Z",
"expectedArrivalWindowEnd": "2025-09-01T14:00:00Z",
"address": {
"street1": "1 Santa Monica Blvd",
"city": "Santa Monica",
"stateOrProvince": "CA",
"postalCode": "90401",
"country": "US"
}
},
{
"sequence": 2,
"stopActivity": "DELIVERY",
"expectedArrivalWindowStart": "2025-09-02T12:00:00Z",
"expectedArrivalWindowEnd": "2025-09-02T14:00:00Z",
"address": {
"street1": "1 Market St",
"city": "San Francisco",
"stateOrProvince": "CA",
"postalCode": "94105",
"country": "US"
}
}
],
"items": [
{
"quantity": 600,
"packagingUnit": {
"unitType": "CARTON",
"quantity": 60
},
"handlingUnit": {
"unitType": "PALLET",
"quantity": 3
},
"description": "600 pieces packed in 60 cartons on 3 pallets",
"totalWeightLbs": 12000,
"lengthInches": 48,
"widthInches": 40,
"heightInches": 60,
"freightClass": "70",
"nmfc": "123456"
}
]
}
}
}
}
},
"responses": {
"204": {
"description": "Load created successfully"
},
"400": {
"description": "Bad request (work in progress)"
}
}
},
"patch": {
"operationId": "patchLoad",
"tags": [
"Load Management"
],
"summary": "Patch a load",
"description": "Apply one or more patch operations to an existing load using a JSON Patch-inspired format ([RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)).\n\nEach operation targets a specific field by JSON Pointer path and specifies how to change it.\n\n## Supported operations\n\n| `op` | Description |\n|---------|-------------|\n| `add` | Set a value or insert into an array at a specific index. |\n| `remove` | Remove a value or array element. |\n| `replace` | Replace an existing value. |\n| `append` | *(Custom)* Append an item to the end of an array. |\n| `upsert` | *(Custom)* Update an existing array element matching the `where` condition, or insert a new one if no match is found. |\n\n## Allowed paths\n\nOperations are validated against an allowlist of supported paths. Attempts to modify other paths will be rejected.\n\n| `path` | Supported operations | Value example |\n|--------|---------------------|---------------|\n| `/status` | `add`, `replace` | `\"DISPATCHED\"` |\n| `/mode` | `add`, `replace` | `\"FTL\"` |\n| `/loadType` | `add`, `replace` | `\"SPOT\"` |\n| `/equipment` | `add`, `replace` | `\"DRY_VAN\"` |\n| `/equipmentDescription` | `add`, `replace` | `\"53ft Dry Van\"` |\n| `/commodity` | `add`, `replace` | `\"Electronics\"` |\n| `/service` | `add`, `replace` | `\"STANDARD\"` |\n| `/targetRate` | `add`, `replace` | `1250.00` |\n| `/maxRate` | `add`, `replace` | `3000.00` |\n| `/totalRate` | `add`, `replace` | `2750.00` |\n| `/highValueAmount` | `add`, `replace` | `50000` |\n| `/totalMiles` | `add`, `replace` | `1200` |\n| `/tarpSize` | `add`, `replace` | `\"40x48\"` |\n| `/customerName` | `add`, `replace` | `\"Acme Corp\"` |\n| `/customerContact` | `add`, `replace` | `\"Jane Smith\"` |\n| `/customerNotes` | `add`, `replace` | `\"Call before delivery\"` |\n| `/customerId` | `add`, `replace` | `\"ACME-001\"` |\n| `/isPostedToDAT` | `add`, `replace` | `true` |\n| `/bidExpiration` | `add`, `replace` | `\"2025-08-21T12:34:56Z\"` |\n| `/lastLocationUpdate` | `add`, `replace` | `\"2025-10-15T20:20:00Z\"` |\n| `/weight` | `add`, `replace` | `{\"value\": 45000, \"unit\": \"LB\"}` |\n| `/dimensions` | `add`, `replace` | `{\"lengthInches\": 600, \"widthInches\": 96, \"heightInches\": 108}` |\n| `/minimumTemperature` | `add`, `replace` | `{\"value\": 32, \"unit\": \"F\"}` |\n| `/maximumTemperature` | `add`, `replace` | `{\"value\": 68, \"unit\": \"F\"}` |\n| `/minimumBulkHeadTemperature` | `add`, `replace` | `{\"value\": 35, \"unit\": \"F\"}` |\n| `/maximumBulkHeadTemperature` | `add`, `replace` | `{\"value\": 65, \"unit\": \"F\"}` |\n| `/externalTrackingStatus` | `add`, `replace` | `{\"source\": \"MACROPOINT\", \"code\": \"READY\"}` |\n| `/customData` | `add`, `replace` | `{\"key\": \"value\"}` |\n| `/notes` | `add`, `remove`, `append`, `upsert` | `{\"text\": \"Driver is 30 min out\"}` |\n| `/accessorials` | `add`, `remove`, `append`, `upsert` | `\"HAZMAT\"` |\n| `/referenceNumbers` | `add`, `remove`, `append`, `upsert` | `{\"name\": \"PO_NUMBER\", \"value\": \"PO-12345\"}` |\n| `/trackingEvents` | `add`, `remove`, `append`, `upsert` | `{\"eventType\": \"PICKED_UP\", \"eventSource\": \"CARRIER_API\", \"eventUtc\": \"2025-08-21T12:34:56Z\"}` |\n| `/bidCustomValues` | `add`, `remove`, `append`, `upsert` | `{\"name\": \"rush\", \"value\": \"true\"}` |\n| `/commodityItems` | `add`, `remove`, `append`, `upsert` | `{\"quantity\": 10, \"description\": \"boxes\"}` |\n| `/route` | `add`, `remove`, `append`, `upsert` | `{\"sequence\": 1, \"stopActivity\": \"PICKUP\"}` |\n| `/carrier` | `add`, `remove`, `replace` | `add`: assign a carrier when the load has none.<br>`replace`: replace the carrier already on the load.<br>Both use `value` shaped as [**LoadPatchCarrier**](#model/LoadPatchCarrier).<br>`remove`: unassign the carrier (omit `value`). |\n| `/carrier/drivers` | `append`, `replace` | `append`: one [**LoadPatchCarrierDriver**](#model/LoadPatchCarrierDriver).<br>`replace`: array of the same schema (replaces the full drivers list). |\n| `/carrier/contacts` | `append`, `replace` | `append`: one [**LoadPatchCarrierContact**](#model/LoadPatchCarrierContact).<br>`replace`: array of the same schema (replaces the full contacts list). |\n\n## Examples\n\n**Replace a simple field:**\n\n```json\n{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"IN_TRANSIT\" }\n```\n\n**Append to an array:**\n\n```json\n{ \"op\": \"append\", \"path\": \"/notes\", \"value\": { \"text\": \"Driver is 30 min out\" } }\n```\n\n**Upsert an array element (update stop 1 if it exists, insert if not):**\n\n```json\n{ \"op\": \"upsert\", \"path\": \"/route\", \"value\": { \"sequence\": 1, \"stopActivity\": \"PICKUP\" }, \"where\": { \"sequence\": 1 } }\n```\n\n**Assign carrier on load:**\n\n```json\n{\n \"op\": \"add\",\n \"path\": \"/carrier\",\n \"value\": {\n \"carrierId\": \"tms-carrier-42\",\n \"name\": \"Acme Trucking\",\n \"dotNumber\": 1234567,\n \"drivers\": [{ \"id\": \"drv-1\", \"name\": \"Driver One\", \"phone\": \"+12081234567\" }],\n \"contacts\": [\n { \"role\": \"DISPATCHER\", \"name\": \"Dispatch\", \"email\": \"dispatch@example.com\" },\n { \"role\": \"AP_REP\", \"name\": \"AP\", \"email\": \"ap@example.com\" }\n ]\n }\n}\n```\n\n**Clear carrier from load:**\n\n```json\n{ \"op\": \"remove\", \"path\": \"/carrier\" }\n```\n\n**Append a driver:**\n\n```json\n{\n \"op\": \"append\",\n \"path\": \"/carrier/drivers\",\n \"value\": {\n \"id\": \"drv-2\",\n \"name\": \"Jane Driver\",\n \"phone\": \"+12081234568\",\n \"phoneExtension\": \"101\"\n }\n}\n```\n\n**Replace carrier contacts:**\n\n```json\n{\n \"loadReference\": \"LOAD-12345\",\n \"operations\": [\n {\n \"op\": \"replace\",\n \"path\": \"/carrier/contacts\",\n \"value\": [\n {\n \"id\": \"contact-dispatch-1\",\n \"role\": \"DISPATCHER\",\n \"name\": \"Night dispatch\",\n \"email\": \"dispatch@example.com\",\n \"phone\": \"+12081234569\",\n \"phoneExtension\": \"202\"\n },\n {\n \"id\": \"contact-ap-1\",\n \"role\": \"AP_REP\",\n \"name\": \"Accounts payable\",\n \"email\": \"ap@example.com\",\n \"phone\": \"+12081234570\",\n \"phoneExtension\": \"303\"\n }\n ]\n }\n ]\n}\n```\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoadPatchRequest"
},
"examples": {
"statusAndNotes": {
"summary": "Status and notes",
"value": {
"loadReference": "LOAD-12345",
"operations": [
{
"op": "replace",
"path": "/status",
"value": "IN_TRANSIT"
},
{
"op": "append",
"path": "/notes",
"value": {
"text": "Driver is 30 min out"
}
}
]
}
},
"carrierAssign": {
"summary": "Assign carrier on load",
"value": {
"loadReference": "LOAD-12345",
"operations": [
{
"op": "add",
"path": "/carrier",
"value": {
"carrierId": "tms-carrier-42",
"name": "Acme Trucking",
"dotNumber": 1234567,
"drivers": [
{
"id": "drv-1",
"name": "Driver One",
"phone": "+12081234567"
}
],
"contacts": [
{
"role": "DISPATCHER",
"name": "Dispatch",
"email": "dispatch@example.com"
},
{
"role": "AP_REP",
"name": "AP",
"email": "ap@example.com"
}
]
}
}
]
}
},
"carrierRemove": {
"summary": "Remove carrier from load",
"value": {
"loadReference": "LOAD-12345",
"operations": [
{
"op": "remove",
"path": "/carrier"
}
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "Load patched successfully"
},
"400": {
"description": "Bad request — invalid operation, disallowed path, or missing required field",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"404": {
"description": "Load not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
}
},
"/v2/loads/tracking": {
"post": {
"operationId": "addTrackingEvent",
"tags": [
"Load Management"
],
"summary": "Add a tracking event",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrackingEventRequest"
}
}
}
},
"responses": {
"204": {
"description": "Load updated successfully"
},
"400": {
"description": "Bad request (work in progress)"
}
}
}
},
"/v2/carrier-issues/external-ref": {
"post": {
"operationId": "reportCarrierIssueExternalId",
"tags": [
"Carrier Support"
],
"summary": "Report the external incident id for a carrier issue",
"description": "After you receive a `CARRIER_ISSUE_UPDATED` webhook and create the incident in your own TMS, call this endpoint with the `carrierIssueId` from that webhook and your incident id (`externalId`). Augment stores the correlation so subsequent `CARRIER_ISSUE_UPDATED` events for the same issue include your `externalId` — letting you update the existing incident in place instead of creating a duplicate.\n\nThe call is idempotent: sending it again for the same `carrierIssueId` just updates the stored `externalId`. It is optional — if you never call it, events keep arriving without an `externalId` and nothing else changes.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierIssueExternalRefRequest"
},
"example": {
"carrierIssueId": "01JCARRIERISSUERECORD00001",
"externalId": "TMS-INC-30275"
}
}
}
},
"responses": {
"204": {
"description": "External reference recorded"
},
"422": {
"description": "Invalid payload"
}
}
}
},
"/v1/carriers": {
"post": {
"operationId": "createOrUpdateCarrier",
"tags": [
"Carrier Management"
],
"summary": "Create or update carrier",
"description": "Create a new carrier or update an existing one. This endpoint supports three operations:\n- **Creation**: Provide all required fields to create a new carrier.\n- **Partial Update**: Include only the fields you want to update. Carriers\n are matched by `tmsId`, so provide the `tmsId` of the carrier you want\n to update.\n\n- **Full Update**: Include all fields to completely replace the carrier\n data.\n\nFor updating managers and contacts, it is highly recommended to provide `tmsId` for each manager and contact when creating them. This allows the system to match and update existing managers/contacts by their `tmsId` during subsequent updates. If `tmsId` is not provided for managers or contacts, you will need to clear the entire array and re-add all managers/contacts when updating.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierRequest"
},
"example": {
"name": "Acme Logistics",
"tmsId": "acme-tms-001",
"dotNumber": 1234567,
"mcNumber": 765432,
"customData": {
"tier": "gold",
"score": 98.5,
"verified": true,
"aliases": [
"Acme Freight",
"Acme Carriers LLC"
],
"routing": {
"defaultRegion": "NS",
"allowCrossBorder": false
}
}
}
}
}
},
"responses": {
"201": {
"description": "Carrier created or updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"422": {
"description": "Unprocessable Entity - Validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
},
"get": {
"operationId": "getCarrierByIdentifier",
"tags": [
"Carrier Management"
],
"summary": "Get carrier by DOT or MC number",
"description": "Fetch a carrier by its DOT number or MC number. Returns the carrier with associated managers and contacts.\n",
"parameters": [
{
"name": "dotNumber",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"description": "DOT number"
},
{
"name": "mcNumber",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"description": "MC number"
}
],
"responses": {
"200": {
"description": "Carrier found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"404": {
"description": "Carrier not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
}
},
"/v1/carriers/bulk": {
"post": {
"operationId": "bulkUpsertCarriers",
"tags": [
"Carrier Management"
],
"summary": "Bulk create or update carriers",
"description": "Create or update multiple carriers in a single request. Maximum 20 carriers per request. Each carrier is processed in its own transaction. Partial success is supported - some carriers may succeed while others fail.\n",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpsertCarriersRequest"
}
}
}
},
"responses": {
"200": {
"description": "Bulk operation completed (may have partial success)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpsertCarriersResponse"
}
}
}
},
"400": {
"description": "Bad request (e.g., exceeds maximum batch size)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"422": {
"description": "Unprocessable Entity - Validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
}
},
"/v1/carriers/{carrierId}": {
"get": {
"operationId": "getCarrierById",
"tags": [
"Carrier Management"
],
"summary": "Get carrier by ID",
"description": "Fetch a carrier by its carrier ID. Returns the carrier with associated managers and contacts.\n",
"parameters": [
{
"name": "carrierId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Augment's carrier identifier, returned as `carrierId` in the create/update carrier response."
}
],
"responses": {
"200": {
"description": "Carrier found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CarrierResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"404": {
"description": "Carrier not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
},
"delete": {
"operationId": "archiveCarrier",
"tags": [
"Carrier Management"
],
"summary": "Archive carrier",
"description": "Soft delete a carrier. The carrier will no longer be returned in GET requests.\n",
"parameters": [
{
"name": "carrierId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Augment's carrier identifier, returned as `carrierId` in the create/update carrier response."
}
],
"responses": {
"204": {
"description": "Carrier archived successfully"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
},
"404": {
"description": "Carrier not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorBody"
}
}
}
}
}
}
},
"/v2/webhook-endpoints": {
"get": {
"tags": [
"Webhook Endpoints"
],
"operationId": "listWebhookEndpoints",
"summary": "List webhook endpoints",
"security": [
{
"httpBasic": []
}
],
"description": "Lists public webhook endpoints for the authenticated brokerage. Customers do not pass `brokerageKey`; the brokerage is resolved from the API key.\n\nAccess to webhook management is gated by brokerage. Talk to Augment to enable access before relying on this endpoint.\n",
"responses": {
"200": {
"description": "Webhook endpoints returned successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEndpoint"
# --- truncated at 32 KB (217 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/augment/refs/heads/main/openapi/augment-openapi-original.json