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 location API

Company location operations

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

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

This API exposes 5 operations across 4 paths, and defines 21 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}.

5 operations 4 paths 21 schemas 4 GET1 OPTIONS

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 location 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 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 OPTIONS. Each is listed below with its method, path, parameters, and response codes.

location 5

Company location operations

GET
/location/list
Retrieve a list of company locations
location_list_get 1 param → 200401403404429500default
OPTIONS
/location/list
location_list_options → 200401403404429500default
GET
/location
Get a Location list
get-location-list → 200
GET
/location/{location_id}
Get a Location
get-location 1 param → 200
GET
/location/{location_id}/product
Get a Product list
get-location-product-list 1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Location (15 properties), CustomField (8 properties), CustomField_2 (7 properties), Problem (5 properties). Each schema is shown below with its type and property counts.

CodeMessage
object
A generic error object generally used for 500 responses
2 properties 2 required
LocationList
array
Error
object
1 property
DateTime
string
A timestamp of last modification of the entry.
TimeZone
string
CodeEnum
string
CustomField_2
array
7 properties
CustomFieldType
string
ProductList
array
CustomField
object
8 properties
LocationListResponse
Location
object
15 properties
Errors
array
A list of errors that occurred during processing
Shift
object
3 properties
Message
string
StateCode
string
Problem
object
5 properties
Product
object
2 properties
HashedId
string
Location_2
object
3 properties
Department
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-location-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 payables API
Roadsync payees API
Roadsync payment API
Roadsync ping API