Freshteam source

Introduction

The Freshteam source connector lets you authenticate to Freshteam and (when available) extract data from your Freshteam account.

Setup

Prerequisites

• A Freshteam account and access to an API key.
• Your Freshteam base domain (the subdomain used in your Freshteam URL).

Get your Freshteam base domain

Your Freshteam account URL looks like:

https://<base_domain>.freshteam.com

Use the <base_domain> portion as the Base domain value.

Base domain requirements

The connector validates that the base domain is a single DNS label:

• Lowercase letters (a-z), digits (0-9), and hyphens (-) only
• Cannot start or end with a hyphen
• Maximum length: 63 characters

Examples:

• Valid: acme, acme-hr, acme123
• Invalid: Acme (must be lowercase), acme_hr (underscore not allowed), -acme / acme-

Create an API key

Create or obtain a Freshteam API key from your Freshteam admin/settings area (where API keys are managed). Ensure the key has permission to access the Freshteam API.

Authentication

This connector uses Bearer token authentication:

• The API key is sent as a bearer token in the Authorization header.

Configuration

Field	Type	Required	Description
base_domain	string	✅	Your Freshteam subdomain (the part before .freshteam.com). Must be a valid DNS label (see requirements above).
api_key	string	✅	Freshteam API key used as a bearer token.

Connectivity check

On connection setup/login, the connector validates credentials by calling:

GET https://<base_domain>.freshteam.com/api/employee_fields

If this request fails (for example due to an invalid domain or API key), the connector will report a credential validation error.

Streams

This connector is currently under development and does not yet expose any streams for extraction.