Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync workorders API

The Workorders API

Roadsync workorders API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include workorders. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 32 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

6 operations 4 paths 32 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync workorders API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

workorders 6

The Workorders API

GET
/{id}
Get Workorder by ID
get-workorder-workorderId 1 param → 200
DELETE
/{id}
Delete workorders by ID
delete-workorders-id 1 param → 200403404
GET
/
Get All Recent Workorders
get-workorders → 200
POST
/
Create New Workorder
post-workorder body → 200400409
POST
/{id}/send
Send workorder
post-id-send 1 param body → 200
POST
/{id}/approve
Approve Workorders
post-id-approve 1 param body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are workorder (20 properties), location (10 properties). Each schema is shown below with its type and property counts.

companyId
string
Hashed company ID attached to each workorder
id
string
The id number of the object being returned.
signedCarrierName
string
Name of carrier who signed workorder
reference
string
Workorder reference for record keeping purposes
comdataApiLocationId
string
Location's unique Roadsync API ID from comdata
workOrderSettingsId
string
Hashed ID for the workorder settings
userId
string
ID of the user creating workorders
signedContactEmail
string
Email of the contact signing the workorder
signedDriverPhone
string
Phone number of driver who signed the workorder
signedContactPhone
string
Phone number of the contact signing the workorder
invoiceId
string
Hashed invoice ID for the workorder
invoiceStatus
string
Status of invoice attached to workorder
signedCustomFields
string
Signed custom fields for workorders
state
string
A valid 2 character state code in the United States.
isLocked
boolean
Boolean representation of if the location is locked
location
object
Location for the workorder
10 properties
updatedAt
string
Updated at value for workorder
email
string
locationId
string
Hashed ID value for the location
timezone
string
Timezone for the location
signedFileId
string
workorder
object
20 properties
lockedAt
string
Time the location was locked
signedContactName
string
Name of the contact signing the workorder
city
string
A valid city in the United States.
phone
string
signedDriverEmail
string
Email of driver who signed the workorder
status
Enum containing the possible workorder status
publicId
integer
The Roadsync Public ID of the workorder
createdAt
string
Created at value for workorder
signedDriverName
string
Name of driver who signed the workorder
locationName
string
Name of the location

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-workorders-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API