Base URL

The Base URL is a common root address for the Tuum API endpoints. To make an API call, select the appropriate base URL for your target Tuum environment.

Tuum base URLs typically use the following format:

https://[api-name].[environment].[domain]

Below, you will find the descriptions of the base URL components.

Base URL component	Description	Example value
api-name	The name of the Tuum API you wish to call.	auth-api, employee-api
environment	The setting or location where the target API resides.	sandbox, dev, test
domain	The domain where the target API resides.	tuumplatform.com

Base URL for Tuum's public sandbox

Use the base URL below to make API calls to the Tuum public sandbox.

https://[api-name].sandbox.tuumplatform.com

Replace the placeholder api-name with the desired API name, like auth-api, account-api, or another supported API.

Examples for the sandbox environment

Auth API

https://auth-api.sandbox.tuumplatform.com

Person API

https://person-api.sandbox.tuumplatform.com

Base URL for your organisation

To make an API call to the Tuum instance assigned to your organisation (e.g. dev, test, staging), obtain the the exact base URL from team Tuum or your organisation's authorised representative.