{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Teams & Organizations","description":"The operational transportation management API. Full access to planning, tracking, invoicing, and integrations — built on the OTM5 open data standard.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"teams--organizations","__idx":0},"children":["Teams & Organizations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organize your users into teams, manage platform administration, and configure organizational settings."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"teams","__idx":1},"children":["Teams"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Teams group users together for assignment, approval workflows, and operational management."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-team","__idx":2},"children":["Create a Team"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/team \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Planning Team Rotterdam\",\n    \"managers\": [{ \"id\": \"user-uuid\" }]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-a-team","__idx":3},"children":["Get a Team"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/team/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-teams","__idx":4},"children":["List Teams"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/teams/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-teams","__idx":5},"children":["Search Teams"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.otms.transportial.com/api/teams/0/20\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Rotterdam\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-a-team","__idx":6},"children":["Update a Team"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.otms.transportial.com/api/team \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"id\": \"team-uuid\",\n    \"name\": \"Planning Team Rotterdam & Den Haag\",\n    \"managers\": [\n      { \"id\": \"user-uuid-1\" },\n      { \"id\": \"user-uuid-2\" }\n    ]\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"administrations","__idx":7},"children":["Administrations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Administrations are financial entities within your platform — they hold invoicing, billing, and accounting configurations."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-an-administration","__idx":8},"children":["Create an Administration"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/administration \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Acme Logistics - Main\",\n    \"currency\": \"EUR\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-administrations","__idx":9},"children":["List Administrations"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/administrations/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"platform-settings","__idx":10},"children":["Platform Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your platform has configurable settings that control behavior across the system."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-settings","__idx":11},"children":["Get Settings"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET https://api.otms.transportial.com/api/settings \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-settings","__idx":12},"children":["Update Settings"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.otms.transportial.com/api/settings \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"language\": \"en\",\n    \"timezone\": \"Europe/Amsterdam\",\n    \"currency\": \"EUR\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"platform-settings-categories","__idx":13},"children":["Platform Settings Categories"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Category"},"children":["Category"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UI settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Branding, default views"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Financial settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency, tax defaults, approval flows"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pricing settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rate calculation rules"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Translation settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language preferences"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notification rules and channels"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer portal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Self-service portal configuration"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-platform-settings","__idx":14},"children":["Update Platform Settings"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X PUT https://api.otms.transportial.com/api/platform/settings \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"settings\": {\n      \"defaultCurrency\": \"EUR\",\n      \"defaultLanguage\": \"en\"\n    }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"platform-billing","__idx":15},"children":["Platform Billing"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-billing-information","__idx":16},"children":["Get Billing Information"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/platform/billing/{id}\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-billing-estimate","__idx":17},"children":["Get Billing Estimate"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/platform/billing/{id}/estimate\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"usage-events","__idx":18},"children":["Usage Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Track platform usage for billing:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# All usage events\ncurl -X GET \"https://api.otms.transportial.com/api/platforms/billing/{id}/usageEvents/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Usage events by date range\ncurl -X GET \"https://api.otms.transportial.com/api/platforms/billing/{id}/usageEvents:byDateRange/2026-03-01/2026-03-31\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"custom-types","__idx":19},"children":["Custom Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create custom entity types for your platform:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/type \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Express delivery\",\n    \"entityType\": \"transportOrder\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-types","__idx":20},"children":["List Types"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.otms.transportial.com/api/types/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tenders--marketplace","__idx":21},"children":["Tenders & Marketplace"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create tenders to get bids from carriers."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-tender","__idx":22},"children":["Create a Tender"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.otms.transportial.com/api/tender \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"name\": \"Weekly Rotterdam-Berlin lane\",\n    \"description\": \"Looking for carrier for weekly FTL Rotterdam to Berlin\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-a-bid","__idx":23},"children":["Submit a Bid"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.otms.transportial.com/api/tender/{tenderId}/bid\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"amount\": 1100.00,\n    \"currency\": \"EUR\",\n    \"validUntil\": \"2026-04-01T23:59:59Z\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"accept--decline--counter-a-bid","__idx":24},"children":["Accept / Decline / Counter a Bid"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Accept\ncurl -X GET \"https://api.otms.transportial.com/api/tender/bid/{bidId}/accept\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Decline\ncurl -X POST \"https://api.otms.transportial.com/api/tender/bid/{bidId}/decline\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# Counter offer\ncurl -X POST \"https://api.otms.transportial.com/api/tender/bid/{bidId}/counter\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\" \\\n  -d '{\n    \"amount\": 1050.00,\n    \"currency\": \"EUR\"\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-tenders-and-bids","__idx":25},"children":["List Tenders and Bids"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# List tenders\ncurl -X GET \"https://api.otms.transportial.com/api/tenders/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n\n# List bids for a tender\ncurl -X GET \"https://api.otms.transportial.com/api/tender/{tenderId}/bids/0/20\" \\\n  -H \"Authorization: Bearer YOUR_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":26},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set up your team structure during ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/onboarding"},"children":["Onboarding"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure roles and permissions in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication & Permissions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API Reference"]}," for all organizational endpoints"]}]}]},"headings":[{"value":"Teams & Organizations","id":"teams--organizations","depth":1},{"value":"Teams","id":"teams","depth":2},{"value":"Create a Team","id":"create-a-team","depth":3},{"value":"Get a Team","id":"get-a-team","depth":3},{"value":"List Teams","id":"list-teams","depth":3},{"value":"Search Teams","id":"search-teams","depth":3},{"value":"Update a Team","id":"update-a-team","depth":3},{"value":"Administrations","id":"administrations","depth":2},{"value":"Create an Administration","id":"create-an-administration","depth":3},{"value":"List Administrations","id":"list-administrations","depth":3},{"value":"Platform Settings","id":"platform-settings","depth":2},{"value":"Get Settings","id":"get-settings","depth":3},{"value":"Update Settings","id":"update-settings","depth":3},{"value":"Platform Settings Categories","id":"platform-settings-categories","depth":3},{"value":"Update Platform Settings","id":"update-platform-settings","depth":3},{"value":"Platform Billing","id":"platform-billing","depth":2},{"value":"Get Billing Information","id":"get-billing-information","depth":3},{"value":"Get Billing Estimate","id":"get-billing-estimate","depth":3},{"value":"Usage Events","id":"usage-events","depth":3},{"value":"Custom Types","id":"custom-types","depth":2},{"value":"List Types","id":"list-types","depth":3},{"value":"Tenders & Marketplace","id":"tenders--marketplace","depth":2},{"value":"Create a Tender","id":"create-a-tender","depth":3},{"value":"Submit a Bid","id":"submit-a-bid","depth":3},{"value":"Accept / Decline / Counter a Bid","id":"accept--decline--counter-a-bid","depth":3},{"value":"List Tenders and Bids","id":"list-tenders-and-bids","depth":3},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Teams & Organizations"}},"lastModified":"2026-03-22T21:04:26.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/teams-and-organizations","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}