Open API 1.0 Overview

Retiring August 12, 2026

Open API 1.0 will be retired on August 12, 2026. After this date, all 1.0 endpoints and webhooks will no longer be available. Open API 2.0 is a completely new integration approach. See the Open API 2.0 documentation to get started.

Open API 1.0 uses a polling-based architecture where you fetch service request data from VectorCare endpoints and receive notifications via webhooks.

Key Differences from 2.0

Feature	v1.0	v2.0
Data retrieval	Polling (GET endpoints)	Webhooks only
Data structure	Dynamic (configurable fields)	Static (fixed fields)
Endpoints	Multiple read endpoints	Webhook + update endpoints
Standing orders	Bulk webhook	Individual webhooks per request

Environment Selector

Use the environment selector in the header to switch between environments. All URLs in the documentation will update automatically.

Requirements

1. VectorCare account with API feature enabled
2. Admin group with these permissions:
   • Can access Open API
   • Can configure Open API Client Credentials
   • Can configure Open API for account
   • Can configure Webhooks

See About Group Permissions for configuration details.

Available Endpoints

Read Operations

• Request List (Partial) - Get list of request IDs and basic info
• Request List (Full) - Get paginated list with full details
• Request Detail - Get complete details for a single request

Update Operations

• State Update - Post trip state changes
• Location Update - Post GPS coordinates

Create Operations

• Create Request - Create new service requests

Account Operations

• Account Details - Get account information

Webhooks

• Webhook Messages - Receive real-time notifications

Getting Started

1. Set up authentication to obtain access tokens
2. Use the Request List endpoint to discover available requests
3. Fetch full details with Request Detail
4. Send updates via State Update and Location Update
5. Configure webhooks to receive real-time notifications