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

The brokers API from Roadsync — 2 operation(s) for brokers.

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

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

This API exposes 2 operations across 2 paths, and defines 12 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}.

2 operations 2 paths 12 schemas 2 GET

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 brokers 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 2

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

brokers 2
GET
/brokers
Get All Brokers
get-brokers → 200
GET
/brokers/{broker_id}
Get a Single Broker
get-brokers-id 1 param → 200401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed is broker (12 properties). Each schema is shown below with its type and property counts.

id
integer
The id number of the object being returned.
brokerName
string
The name of the broker.
city
string
A valid city in the United States.
postalCode
string
A valid postal code in the United States.
phoneNumber
string
A valid phone number belonging to a person or company.
emailAddressBroker
string
A valid email belonging to the Broker, where remittance emails will be received.
brokerIdResponse
integer
The identifier of a Broker to which the Payee has been assigned.
broker
object
The full broker object.
12 properties
addressLineOne
string
The valid address of a person or business in the United States.
state
string
A valid 2 character state code in the United States.
addressLineTwo
string
If necessary, add a second line of the address in the United States.
fundingSourceId
Id representing the funding source (papercheck, ach or wallet).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-brokers-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated 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
Roadsync ping API