Teams & Organizations

Organize your users into teams, manage platform administration, and configure organizational settings.

Teams

Teams group users together for assignment, approval workflows, and operational management.

Create a Team

curl -X POST https://api.otms.transportial.com/api/team \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Planning Team Rotterdam",
    "managers": [{ "id": "user-uuid" }]
  }'

Get a Team

curl -X GET "https://api.otms.transportial.com/api/team/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

List Teams

curl -X GET "https://api.otms.transportial.com/api/teams/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Search Teams

curl -X POST "https://api.otms.transportial.com/api/teams/0/20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Rotterdam"
  }'

Update a Team

curl -X PUT https://api.otms.transportial.com/api/team \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "id": "team-uuid",
    "name": "Planning Team Rotterdam & Den Haag",
    "managers": [
      { "id": "user-uuid-1" },
      { "id": "user-uuid-2" }
    ]
  }'

Administrations

Administrations are financial entities within your platform — they hold invoicing, billing, and accounting configurations.

Create an Administration

curl -X POST https://api.otms.transportial.com/api/administration \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Acme Logistics - Main",
    "currency": "EUR"
  }'

List Administrations

curl -X GET "https://api.otms.transportial.com/api/administrations/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Platform Settings

Your platform has configurable settings that control behavior across the system.

Get Settings

curl -X GET https://api.otms.transportial.com/api/settings \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Settings

curl -X PUT https://api.otms.transportial.com/api/settings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "language": "en",
    "timezone": "Europe/Amsterdam",
    "currency": "EUR"
  }'

Platform Settings Categories

Category	Description
UI settings	Branding, default views
Financial settings	Currency, tax defaults, approval flows
Pricing settings	Rate calculation rules
Translation settings	Language preferences
Alert settings	Notification rules and channels
Customer portal	Self-service portal configuration

Update Platform Settings

curl -X PUT https://api.otms.transportial.com/api/platform/settings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "settings": {
      "defaultCurrency": "EUR",
      "defaultLanguage": "en"
    }
  }'

Platform Billing

Get Billing Information

curl -X GET "https://api.otms.transportial.com/api/platform/billing/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Billing Estimate

curl -X GET "https://api.otms.transportial.com/api/platform/billing/{id}/estimate" \
  -H "Authorization: Bearer YOUR_TOKEN"

Usage Events

Track platform usage for billing:

# All usage events
curl -X GET "https://api.otms.transportial.com/api/platforms/billing/{id}/usageEvents/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

# Usage events by date range
curl -X GET "https://api.otms.transportial.com/api/platforms/billing/{id}/usageEvents:byDateRange/2026-03-01/2026-03-31" \
  -H "Authorization: Bearer YOUR_TOKEN"

Custom Types

Create custom entity types for your platform:

curl -X POST https://api.otms.transportial.com/api/type \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Express delivery",
    "entityType": "transportOrder"
  }'

List Types

curl -X GET "https://api.otms.transportial.com/api/types/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Tenders & Marketplace

Create tenders to get bids from carriers.

Create a Tender

curl -X POST https://api.otms.transportial.com/api/tender \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "name": "Weekly Rotterdam-Berlin lane",
    "description": "Looking for carrier for weekly FTL Rotterdam to Berlin"
  }'

Submit a Bid

curl -X POST "https://api.otms.transportial.com/api/tender/{tenderId}/bid" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "amount": 1100.00,
    "currency": "EUR",
    "validUntil": "2026-04-01T23:59:59Z"
  }'

Accept / Decline / Counter a Bid

# Accept
curl -X GET "https://api.otms.transportial.com/api/tender/bid/{bidId}/accept" \
  -H "Authorization: Bearer YOUR_TOKEN"

# Decline
curl -X POST "https://api.otms.transportial.com/api/tender/bid/{bidId}/decline" \
  -H "Authorization: Bearer YOUR_TOKEN"

# Counter offer
curl -X POST "https://api.otms.transportial.com/api/tender/bid/{bidId}/counter" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "amount": 1050.00,
    "currency": "EUR"
  }'

List Tenders and Bids

# List tenders
curl -X GET "https://api.otms.transportial.com/api/tenders/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

# List bids for a tender
curl -X GET "https://api.otms.transportial.com/api/tender/{tenderId}/bids/0/20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Next Steps

Set up your team structure during Onboarding
Configure roles and permissions in Authentication & Permissions
See the full API Reference for all organizational endpoints