Configure Connection

Teamwork guide

Obtain a Teamwork API token, configure the tenant URL and token in NIM, and test access by retrieving companies.

Before you startDirect link to Before you start

Follow the Teamwork API getting started guide to obtain your site URL and API token. API access follows the permissions of the Teamwork user associated with the token.

NIM requires Tenant URL and Token.

Prepare the site URL and tokenDirect link to Prepare the site URL and token

Sign in to Teamwork with the account whose permissions will be used for the integration.
Open your avatar menu and select Edit my details > API & Mobile > Show your token.
Copy the API key securely for use as the NIM Token.
Copy the site's base URL, excluding the /app path and anything after it. Use your actual regional or custom domain.
Confirm that the account can access the project data and companies needed by your process, and create people or companies where required.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a Teamwork system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Tenant URL	Your Teamwork site base URL, such as `https://yourSiteName.teamwork.com` or `https://yourSiteName.eu.teamwork.com`.
Token	The API key copied from the Teamwork user's profile.

Test company accessDirect link to Test company access

Select Test Connection. NIM calls this endpoint using the configured Tenant URL:
```
GET /companies
```
The request retrieves a list of companies.
Confirm that the test succeeds. If it fails, verify the Tenant URL, API token, and associated user's access.
Collect the system and inspect companies, people, and projects, along with any project-related collections your process needs.
Validate intended people and company creation, project updates, and project custom field operations with safe test records before enabling automation.

The connection test reads companies. Validate other collections and each intended write operation separately.

Step 1 of 3