How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OneRail Organization API

The Organization API from OneRail — 80 operation(s) for organization.

OneRail Organization API is one of 75 APIs that OneRail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 100 operations across 80 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /.

100 operations 80 paths 0 schemas 2 DELETE51 GET4 PATCH29 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://onerail-delivery-api-prod.azurewebsites.net
Authentication
HTTP Bearer, API Key, API Key, OAuth 2.0
License
UNLICENSED
Resource Areas
1

Authentication & Security 4

OneRail Organization API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer). An API key is passed in the header as X-ONERAIL-API-KEY (ApiKey). An API key is passed in the header as X-ONERAIL-APP-ID (AppId). It supports OAuth 2.0 (OAuth) using the authorizationCode flow. By default, every request must be authenticated.

  • bearer — Standard JWT bearer token used for authenticated OmniPoint users and internal service-to-service calls. Clients send Authorization: Bearer and the token is val…
  • ApiKey — Shared secret key used for machine-to-machine integrations. Must be sent together with X-ONERAIL-APP-ID and is validated against the stored ApiAuth record for…
  • AppId — Application identifier (UUID) that pairs with X-ONERAIL-API-KEY for machine-to-machine integrations. Both headers are required for ApiKey-based authentication.
  • OAuth — OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed integrations). Clients obtain tokens from their own IdP outside of this API and ca…

Paths & Operations 100

Across 80 paths, the API surfaces 100 operations — 2 DELETE, 51 GET, 4 PATCH, 29 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Organization 100
GET
/v1/organizations
Get all organizations user has access to
getAllOrganizations 7 params → 200default
GET
/v2/organizations
Get all organizations user has access to, with reduced payload
getAllV2 6 params → 200default
POST
/v3/organizations
Get all organizations user has access to, with reduced payload
listOrganizationsV3 body → 200default
POST
/v1/organizations/users
Search Users in different organizations
searchUsers body → 200default
POST
/v1/organization
Creates a new Organization
createOrganization body → 200default
GET
/v1/organization/preferences/api
Get organization preferences by api key and appId
getPreferenceViaApi → 200404default
GET
/v1/organization/{organizationId}
Get organization by id
getOrganization 1 param → 200404default
PUT
/v1/organization/{organizationId}
Updates Organization
updateOrganization 1 param body → 200404default
PATCH
/v1/organization/{organizationId}
Partial Updates Organization
partialUpdate 1 param body → 200404default
GET
/v1/organization/{organizationId}/api
Get organization by id (API)
getApi 1 param → 200404default
GET
/v1/organization/{organizationId}/shippers
Gets children organizations of the given Organization Id
getShipperOrganizations 3 params → 200404default
GET
/v1/organization/{organizationId}/locations
Get organization's locations
getLocations 8 params → 200404default
POST
/v1/organization/{organizationId}/primary-location
Creates or updates organization primary location
updatePrimaryLocation 1 param body → 200default
PATCH
/v1/organization/{organizationId}/inactivate
Sets organization as inactive
setInactive 1 param body → 200default
PATCH
/v1/organization/{organizationId}/webhook-url
Update organization webhook URL
updateWebhookUrl 1 param body → 200404default
POST
/v1/organization/{organizationId}/dot
Update organization DOT information
updateDot 1 param body → 200404default
GET
/v1/organization/{organizationId}/users
Get organization's users
getUsers 6 params → 200404default
GET
/v1/organization/{organizationId}/drivers
Get organization's users
getOrganizationDrivers 7 params → 200404default
GET
/v1/organization/{organizationId}/column-mappings
Get organization by id
getOrganizationColumnMappings 1 param → 200404default
GET
/v1/organization/{organizationId}/driver/{driverId}/tooltip
Get driver tooltip info
getDriverTooltip 2 params → 200404512default
POST
/v1/organization/{organizationId}/user/distances
get distance between users and first route pickup
getUserDistances 1 param body → 200404default
GET
/v1/organization/{organizationId}/user/{userId}/locations
Get organization user's locations
getUserLocations 6 params → 200404default
GET
/v1/organization/{organizationId}/available-lp-contracts
Get Available Lp Contracts for a Org ID
getAvailableLpContracts 4 params → 200404default
GET
/v1/organization/{organizationId}/roles
Get organization's roles
getRoles 5 params → 200default
GET
/v1/organization/{organizationId}/assignable-roles
Get roles that loggin user has the ability to assign.
getAssignableRoles 1 param → 200default
GET
/v1/organization/{organizationId}/fleet-assets
Get organization's fleet assets
getFleetAssets 1 param → 200404default
POST
/v1/organization/{organizationId}/fleet-assets
Create Fleet Assets for an Organization at the global level
createFleetAssets 1 param body → 200404default
PUT
/v1/organization/{organizationId}/fleet-assets
Update Fleet Assets for an Organization at the global level
updateFleetAssets 1 param body → 200404default
GET
/v1/organization/{organizationId}/external-fleet-assets
Get organization's External fleet assets
getExternalFleetAssets 1 param → 200404default
POST
/v1/organization/{organizationId}/external-fleet-assets
Create External Fleet Assets for an Organization
createExternalFleetAsset 1 param body → 200404default
POST
/v1/organization/{organizationId}/external-fleet-assets/{fleetVehicleId}/remove
remove External Fleet Assets for an Organization
removeExternalFleetAssets 2 params → 200404default
PUT
/v1/organization/{organizationId}/bulk-users
Bulk update users by passing in an array of users with attributes to update and either an ID or an employeeId to help identify the user (if both are included in a user, employeeId will be updated)
bulkUpdate 1 param body → 200default
POST
/v1/organization/{organizationId}/bulk-users
Creates users from a CSV file
bulkCreate 1 param body → 200default
GET
/v1/organization/{organizationId}/lp-markets
Get organization's LP Markets
getLPMarkets 6 params → 200default
GET
/v1/organization/{organizationId}/shipper-contracts
Get organization's Shipper Contracts
getShipperContracts 5 params → 200default
GET
/v1/organization/{organizationId}/lp-contracts
Get all shipper contracts of all generated lp contract slas for this orgnization
getLPContracts 5 params → 200default
GET
/v1/organization/shipper-contract-with-slas
Get organization's Shipper Contracts that have at least 1 sla
getShipperContractWithSlas 4 params → 200default
GET
/v1/organization/related
Data for creating a new Organization
related → 200default
GET
/v1/organization/{organizationId}/deliveries
Get organization's deliveries
getOrganizationDeliveries 11 params → 200404default
POST
/v1/organization/{organizationId}/delivery
Creates a new delivery for the organization
createDelivery 1 param body → 200default
GET
/v1/organization/{organizationId}/delivery/{deliveryId}
Get a delivery for the organization
getOrganizationDelivery 2 params → 200404default
PUT
/v1/organization/{organizationId}/delivery/{deliveryId}
Updates a delivery for the organization
updateDelivery 2 params body → 200404default
PATCH
/v1/organization/{organizationId}/delivery/{deliveryId}
Patches a delivery for the organization
patchDelivery 2 params body → 200404default
POST
/v1/organization/{organizationId}/delivery/{deliveryId}/image
Uploads a proof of delivery image
deliveryImage 2 params body → 200default
POST
/v1/organization/{organizationId}/delivery/{deliveryId}/images-download
Get all POP or POD images for delivery
getDeliveryProofImages 2 params body → 200default
POST
/v1/organization/{organizationId}/delivery/{deliveryId}/images-delete
Soft delete proof images (POP/POD) for a delivery
deleteDeliveryProofImages 2 params body → 200404default
GET
/v1/organization/{organizationId}/delivery/{deliveryId}/delivery-attempts
Get a delivery's attempts
getDeliveryAttempts 2 params → 200404default
GET
/v2/organization/{organizationId}/delivery/{deliveryId}/delivery-attempts
Get a delivery's attempts
getDeliveryAttemptsWithLimit 4 params → 200404default
GET
/v2/organization/delivery/{deliveryId}/delivery-attempts-api
Get a delivery's attempts with api key and app Id
getDeliveryAttemptsWithLimitApi 3 params → 200404default
GET
/v1/organization/{organizationId}/file-uploads
Gets the file uploads in relation to a provided organization id
getAllFileUploadsForOrganization 10 params → 200default
POST
/v1/organization/{organizationId}/bulk-products-delete
Delete organization's Products
deleteOrgProducts 1 param body → 200default
POST
/v1/organization/{organizationId}/bulk-products-restore
Restore organization's Products
restoreOrgProducts 1 param body → 200default
GET
/v1/organization/{organizationId}/product/{productId}
Get product for oganization
getSingleProduct 2 params → 200default
PUT
/v1/organization/{organizationId}/product/{productId}
Edit organization's Product
editOrgProduct 2 params body → 200default
GET
/v1/organization/{organizationId}/products
Get organization's Products
getProducts 6 params → 200default
GET
/v1/organization/{organizationId}/boxes
Get organization's boxes
getBoxes 5 params → 200default
GET
/v1/organization/boxes/api
Get organization's boxes via api
getBoxesApi 4 params → 200default
GET
/v1/organization/{organizationId}/service-levels
Get organization's service levels
getServiceLevels 2 params → 200404default
POST
/v1/organizations/service-levels
Get one or more organization's service levels
getOrgsServiceLevels body → 200404default
GET
/v1/organization/service-levels/api
Get organization's service levels using api
getServiceLevelsApi → 200404default
POST
/v1/organization/{organizationId}/service-level
Create organization's service level
createServiceLevel 1 param body → 200404default
GET
/v1/organization/{organizationId}/service-level/{serviceLevelId}
Get service level details
getServiceLevelDetails 2 params → 200404default
PUT
/v1/organization/{organizationId}/service-level/{serviceLevelId}
update organization's service level
updateServiceLevel 2 params body → 200404default
DELETE
/v1/organization/{organizationId}/service-level/{serviceLevelId}
Get service level details
destroyServiceLevel 2 params → 200404default
PUT
/v1/organization/{organizationId}/service-level/{serviceLevelId}/set-active-state
update organization's service level active state
updateServiceLevelActiveState 3 params body → 200default
GET
/v1/organization/{organizationId}/delivery-state-mapping
Get organization's delivery state mapping
getDeliveryStateMapping 1 param → 200404default
POST
/v1/organization/{organizationId}/order
Creates a new order for the organization with one or more deliveries
createOrder 1 param body → 200default
POST
/v1/organization/{organizationId}/order/{orderId}/add-deliveries
Adds one or more deliveries to an existing order for the organization
addDeliveriesToOrder 3 params body → 200default
POST
/v1/organization/{organizationId}/order/{orderId}/add-returns
Adds one or more returns to an existing order for the organization
addReturnsToOrder 2 params body → 200default
POST
/v1/organization/{organizationId}/order/{orderId}/add-returns/{deliveryId}
Adds one or more returns to an existing order for the organization
addReturnsToOrderAndUpdateDelivery 3 params body → 200default
POST
/v1/organization/{organizationId}/own-fleet
Create Fleet Assets for an Organization at the global level
getOwnFleetByOrgId 2 params body → 200
GET
/v1/organization/{organizationId}/carriers
List of carriers (LPs) with signed contracts with th organizationId provided
carriers 1 param → 200default
GET
/v1/organizations/shippers
List of shippers
shippers 2 params → 200default
GET
/v1/organizations/lps
List of LP orgs
lps 2 params → 200default
GET
/v1/organization/{organizationId}/tree
Get organization tree by id.
getOrganizationTree 1 param → 200default
GET
/v1/organization/{organizationId}/season-pricing
Get SeasonPricings
getAllSeasonPricing 1 param → 200default
POST
/v1/organization/{organizationId}/season-pricing
Create SeasonPricing
createSeasonPricing 1 param body → 200default
PUT
/v1/organization/{organizationId}/season-pricing/{seasonPricingId}
Update SeasonPricing
updateSeasonPricing 2 params body → 200default
DELETE
/v1/organization/{organizationId}/season-pricing/{seasonPricingId}
Remove SeasonPricing
removeSeasonPricing 2 params → 200default
GET
/v1/organization/{organizationId}/holiday/list
Holiday
getList 1 param → 200default
PUT
/v1/organization/{organizationId}/lp-settings
Update LP settings
updateLpSettings 1 param body → 200
GET
/v1/organization/{organizationId}/lp-settings
Get LP settings
getLpSettings 1 param → 200
GET
/v1/organization/{organizationId}/custom-settings
Get organization custom settings
getCustomSettings 1 param → 200404default
PUT
/v1/organization/{organizationId}/custom-settings
Update organization custom settings
updateCustomSettings 1 param body → 200400404default
GET
/v1/organization/{organizationId}/get-lp-deliveries
Get an LP's deliveries
getDeliveriesForLP 6 params → 200404default
PUT
/v1/organization/{organizationId}/lp-features
Update LP features
updateLpFeatures 1 param body → 200
GET
/v1/organization/{organizationId}/lp-features
Get LP features
getLpFeatures 1 param → 200
GET
/v1/organization/{organizationId}/contracts-by-service-levels
Get contracts associated from the service levels ids
getContractsByServiceLevels 2 params → 200404default
POST
/v1/organization/create-lp-shipper
Create LP Shippers
createLPShippers body → 200default
PUT
/v1/organization/{organizationId}/toggle-show-hidden-subscription-plans
Update LP show-hidden-subscription-plans features
toggleShowHiddenSubscriptionPlans 1 param body → 200
POST
/v1/organization/shipper-lp-configuration
Upserts Shipper LP Configurations
upsertShipperLPConfigurations body → 200400500
PUT
/v1/organization/shipper-lp-configuration/delete
Delete Shipper LP Configuration
deleteShipperLPConfiguration body → 200400500
POST
/v1/organization/{organizationId}/lpranking-datadomain-configuration
Upserts LP Ranking Data Domain Configuration
upsertLPRankingDataDomainConfiguration 1 param body → 200400500
GET
/v1/organization/{organizationId}/lpranking-datadomain-configuration
Get LP Ranking Data Domain Configuration
getLPRankingDataDomainConfiguration 1 param → 200400500
GET
/v1/organization/{organizationId}/geofence
Get organization's geofence
getGeofence 1 param → 200404default
POST
/v1/organization/{organizationId}/geofence
Create organization's geofence
createGeofence 1 param body → 200400default
PUT
/v1/organization/{organizationId}/geofence
Update organization's geofence
updateGeofence 1 param body → 200400404default
GET
/v1/organization/{organizationId}/login-security-config
Get organization's login security configuration
getLoginSecurityConfig 1 param → 200default
POST
/v1/organization/{organizationId}/login-security-config
Create or update organization's login security configuration
upsertLoginSecurityConfig 1 param body → 200400default
GET
/v1/organization/{organizationId}/lp-configurations
Get organization's LP Configs
getOrganizationLpConfigurations 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onerail-organization-api-openapi.yml Raw ↑

Other APIs OneRail publishes across the network.

OneRail Delivery API
OneRail Api Auth API
OneRail Assets API
OneRail Associated Location API
OneRail Authentication API
OneRail Blob Storage API API
OneRail Box API
OneRail Bulk Approve SLA Template API
OneRail Bulk Send SLA Template API
OneRail Bulk Uploads API
OneRail Cancellation Reason API
OneRail Carrier API
Where this information came from

This is an independent, third-party profile of OneRail Organization API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.