# Teamwork

This page contains the setup guide and reference information for the Teamwork source connector.

## Prerequisites

- Teamwork console username
- Teamwork console password

## Documentation reference:
Visit `https://apidocs.teamwork.com/docs/teamwork/v3/` for API documentation

## Authentication setup

Teamwork uses basic http auth that uses username and password
Your default login username and password could be used as secrets, ref: `https://apidocs.teamwork.com/guides/teamwork/authentication`


## Configuration

| Input | Type | Description | Default Value |
|-------|------|-------------|---------------|
| `username` | `string` | Username.  |  |
| `password` | `string` | Password.  |  |
| `site_name` | `string` | Site Name. The teamwork site name which appears on the url |  |
| `start_date` | `string` | Start date.  |  |

## Streams
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|-------------|-------------|------------|---------------------|----------------------|
| latestactivity | id | DefaultPaginator | ✅ |  ✅  |
| projects | id | DefaultPaginator | ✅ |  ✅  |
| projects_active | value | DefaultPaginator | ✅ |  ❌  |
| projects_billable | name | DefaultPaginator | ✅ |  ❌  |
| companies | id | DefaultPaginator | ✅ |  ✅  |
| me_timers | id | DefaultPaginator | ✅ |  ✅  |
| time_entries | id | DefaultPaginator | ✅ |  ✅  |
| timelog_totals |  | DefaultPaginator | ✅ |  ❌  |
| dashboards | id | DefaultPaginator | ✅ |  ✅  |
| forms | id | DefaultPaginator | ✅ |  ✅  |
| milestones | id | DefaultPaginator | ✅ |  ✅  |
| milestones_deadlines |  | DefaultPaginator | ✅ |  ❌  |
| notebooks | id | DefaultPaginator | ✅ |  ✅  |
| people | id | DefaultPaginator | ✅ |  ❌  |
| notebooks_comments.json | id | DefaultPaginator | ✅ |  ✅  |
| projectcategories | id | DefaultPaginator | ✅ |  ❌  |
| tasklists | id | DefaultPaginator | ✅ |  ✅  |
| tasks | id | DefaultPaginator | ✅ |  ✅  |
| tags | id | DefaultPaginator | ✅ |  ❌  |
| timesheets |  | DefaultPaginator | ✅ |  ❌  |
| workload_planners |  | DefaultPaginator | ✅ |  ❌  |

## Changelog

<details>
  <summary>Expand to review</summary>

| Version | Date | Pull Request | Subject |
| ------------------ | ------------ | --- | ---------------- |
| 0.0.2 | 2024-10-28 | [47552](https://github.com/airbytehq/airbyte/pull/47552) | Update dependencies |
| 0.0.1 | 2024-09-05 | [45155](https://github.com/airbytehq/airbyte/pull/45155) | Initial release by [@btkcodedev](https://github.com/btkcodedev) via Connector Builder |

</details>