theworxhub-auth-production-api
theworxhub-auth-production-api
TheWorxHub
Extend TheWorxHub with APIs designed to connect systems, share data and support operational workflows.
TheWorxHub APIs are built to support a wide range of integration scenarios, including:
TheWorxHub APIs are designed for organizations looking to:
TheWorxHub APIs are REST-based and return data in JSON format. Full API specifications are available in the API Specifications tab.
TheWorxHub is committed to the security and integrity of your data. Every API call is made over HTTPS, and every call needs both your API key and a token issued for your own TheWorxHub site, so a request only ever reaches your organisation's data.
To access TheWorxHub APIs, you will need:
Ready to integrate? Visit the Get Started tab for step-by-step guidance on authentication, making your first API call, and accessing our full documentation.
theworxhub-auth-production-api
theworxhub-api-production-api
theworxhub-assets-production-api
theworxhub-locations-production-api
theworxhub-workorders-production-api
Create work requests directly in TheWorxHub. Ideal for those who need a simple, straightforward integration without requiring access to additional data or functionality.
Read-only access to the full suite of TheWorxHub APIs, including work orders, assets, locations, and inventory data. Designed for mid to enterprise clients looking to surface TheWorxHub data in external systems.
Full read and write access to the full suite of TheWorxHub APIs, including the ability to create and update work orders, assets, and inventory, for clients requiring deep two-way integration.
To get started, you will need an active TheWorxHub subscription and an approved API package. Contact your account manager or visit Contact Us to begin the onboarding process.
Your developer account and API credentials are created within 5 business days once your purchase is confirmed. You then set your portal password from the email you receive, and your API key and partner credentials are on My apps.
Yes. There is a demo environment available. Contact Client Support to learn more.
The integration guide provides in-depth information to help. We also offering consulting time if needed. Contact Client Support to get started.
The TheWorxHub API provides programmatic access to your facilities and maintenance management data, enabling external systems to connect and interact with TheWorxHub. It is built on REST architecture and returns data in JSON format.
The API is available to active TheWorxHub clients and approved technology partners. Access is granted based on your subscription package. Contact your account manager to discuss options.
TheWorxHub offers APIs across several domains including work orders, assets, and locations. New APIs will continue to be added over time. Visit the API Specifications tab for a full and up-to-date list of available endpoints.
TheWorxHub APIs are available in three packages: Work Request, Core Integration, and Full Integration. Each package offers different levels of access to suit your integration needs. Visit the Overview section for full details.
Core Integration provides read-only access to the full suite of TheWorxHub APIs, including work orders, assets, locations, and inventory data. Full Integration provides full read and write access to the full suite of TheWorxHub APIs, including the ability to create and update work orders, assets, and inventory, for clients requiring deep two-way integration.
Yes. Contact your account manager or visit Contact Us to receive a quote.
Yes. You can upgrade from Work Request or Core Integration to a higher tier at any time. Contact your account manager to discuss upgrading your plan.
Two credentials, both on your application under My apps. Your Key is an API key, sent in the x-api-key header on every request. Your Secret is your partner credentials: you send it, exactly as it is, as the JSON body of POST https://api.us.alm.siemens.com/twh/auth/api/v1/Auth/OAuth/Token (with your x-api-key), and you get back a token at data.item.token. Send that token as Authorization: Bearer <token>, with x-api-key, on every other call. See the Get Started tab for both calls.
The TheWorxHub API supports up to 250 calls per minute. Requests exceeding this limit will receive a 429 Too Many Requests response. We recommend implementing retry logic with exponential backoff in your integration to handle this gracefully.
All TheWorxHub APIs return data in JSON format.
The API returns standard HTTP status codes to indicate the result of each request. In the event of an error, the response will include a status code and a message describing the issue. A 401 means the x-api-key header or the Bearer token is missing or no longer valid - request a new token and try again. A 400 from the token request usually means the Secret was changed: send it exactly as it appears on My apps. A 429 means you have reached your plan's rate limit.
No. Access is controlled by your credentials, not by your network address, so you can call the API from any location over HTTPS.
Full API specifications, including endpoint details, request and response schemas, and example calls, are available in the API Specifications tab.
TheWorxHub takes the security of your data seriously. All API communication is encrypted in transit using TLS. Every call needs both your API key and a token issued for your own TheWorxHub site, so your credentials reach your organisation's data and nothing else.
API access is controlled by the credentials issued to your organization. You are responsible for managing and securing your API credentials. TheWorxHub does not share your data with third parties without your consent.
Contact Client Support immediately so your credentials can be revoked and reissued.
Don't see your question here? Contact Client Support and our team will be happy to help.
Sign in, open My apps, and select your TheWorxHub application. Use the eye icon to reveal each value and the copy icon to copy it exactly.
twh_. Sent in the x-api-key header on every request.PartnerId, PartnerSecret, Instance, and Site or Customer. Use it as-is — do not edit it.Export your Key and the base URL once so you can paste all remaining commands unchanged.
export TWH_BASE_URL="https://api.us.alm.siemens.com/twh" export TWH_API_KEY="<your Key from the portal>"
POST your Secret (the full JSON object from the portal) as the request body. Your Key goes in the x-api-key header. The token is extracted into $TWH_TOKEN.
TWH_TOKEN=$(curl -sS --fail-with-body -X POST \
"$TWH_BASE_URL/auth/api/v1/Auth/OAuth/Token" \
-H "x-api-key: $TWH_API_KEY" \
-H "Content-Type: application/json" \
-d '<your Secret from the portal>' \
| jq -er '.data.item.token') && export TWH_TOKEN
echo "$TWH_TOKEN"401, re-run this step to get a fresh token.
Every request uses the same two-header pattern. Here's a quick sanity check — list the departments for your site:
curl -sS --fail-with-body \
"$TWH_BASE_URL/api/api/v1/Integrations/Departments" \
-H "x-api-key: $TWH_API_KEY" \
-H "Authorization: Bearer $TWH_TOKEN" \
| jq .x-api-key (your Key) and Authorization: Bearer <token>.
Our Postman collection provides ready-to-use API requests for the most common TheWorxHub integration scenarios. Whether you are syncing asset data, automating work orders, or building a custom integration, the collection includes detailed examples to guide you through each use case.
Access the Postman Collection →