> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# harvest-people
> Users & Clients
**Server path:** `/harvest-people` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [`harvest_people_create_billable_rate`](#harvest_people_create_billable_rate) | Create a billable rate |
| [`harvest_people_create_client`](#harvest_people_create_client) | Create a client |
| [`harvest_people_create_contact`](#harvest_people_create_contact) | Create a contact |
| [`harvest_people_create_cost_rate`](#harvest_people_create_cost_rate) | Create a cost rate |
| [`harvest_people_create_role`](#harvest_people_create_role) | Create a role |
| [`harvest_people_create_user`](#harvest_people_create_user) | Create a user |
| [`harvest_people_delete_client`](#harvest_people_delete_client) | Delete a client |
| [`harvest_people_delete_contact`](#harvest_people_delete_contact) | Delete a contact |
| [`harvest_people_delete_role`](#harvest_people_delete_role) | Delete a role |
| [`harvest_people_delete_user`](#harvest_people_delete_user) | Delete a user |
| [`harvest_people_list_active_project_assignments`](#harvest_people_list_active_project_assignments) | List active project assignments |
| [`harvest_people_list_active_project_assignments_for_the_currently_authenticated_user`](#harvest_people_list_active_project_assignments_for_the_currently_authenticated_user) | List active project assignments for the currently authenticated user |
| [`harvest_people_list_assigned_teammates_for_specific_user`](#harvest_people_list_assigned_teammates_for_specific_user) | List all assigned teammates for a specific user |
| [`harvest_people_list_billable_rates_for_specific_user`](#harvest_people_list_billable_rates_for_specific_user) | List all billable rates for a specific user |
| [`harvest_people_list_clients`](#harvest_people_list_clients) | List all clients |
| [`harvest_people_list_contacts`](#harvest_people_list_contacts) | List all contacts |
| [`harvest_people_list_cost_rates_for_specific_user`](#harvest_people_list_cost_rates_for_specific_user) | List all cost rates for a specific user |
| [`harvest_people_list_roles`](#harvest_people_list_roles) | List all roles |
| [`harvest_people_list_users`](#harvest_people_list_users) | List all users |
| [`harvest_people_retrieve_billable_rate`](#harvest_people_retrieve_billable_rate) | Retrieve a billable rate |
| [`harvest_people_retrieve_client`](#harvest_people_retrieve_client) | Retrieve a client |
| [`harvest_people_retrieve_company`](#harvest_people_retrieve_company) | Retrieve a company |
| [`harvest_people_retrieve_contact`](#harvest_people_retrieve_contact) | Retrieve a contact |
| [`harvest_people_retrieve_cost_rate`](#harvest_people_retrieve_cost_rate) | Retrieve a cost rate |
| [`harvest_people_retrieve_role`](#harvest_people_retrieve_role) | Retrieve a role |
| [`harvest_people_retrieve_the_currently_authenticated_user`](#harvest_people_retrieve_the_currently_authenticated_user) | Retrieve the currently authenticated user |
| [`harvest_people_retrieve_user`](#harvest_people_retrieve_user) | Retrieve a user |
| [`harvest_people_update_client`](#harvest_people_update_client) | Update a client |
| [`harvest_people_update_company`](#harvest_people_update_company) | Update a company |
| [`harvest_people_update_contact`](#harvest_people_update_contact) | Update a contact |
| [`harvest_people_update_role`](#harvest_people_update_role) | Update a role |
| [`harvest_people_update_user`](#harvest_people_update_user) | Update a user |
| [`harvest_people_update_user_assigned_teammates`](#harvest_people_update_user_assigned_teammates) | Update a user’s assigned teammates |
***
## harvest\_people\_create\_billable\_rate
Create a billable rate
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------ | ------ | -------- | ------- | ----------- | ------------------------------------------------------------------------ |
| `userId` | string | Yes | — | User Id | |
| `amount` | number | null | Yes | — | The amount of the billable rate. |
| `start_date` | string | null | No | — | The date the billable rate is effective. Cannot be a date in the future. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"amount": {
"type": [
"number",
"null"
],
"description": "The amount of the billable rate."
},
"start_date": {
"type": [
"string",
"null"
],
"description": "The date the billable rate is effective. Cannot be a date in the future."
}
},
"required": [
"PCID",
"userId",
"amount"
]
}
```
***
## harvest\_people\_create\_client
Create a client
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------- | ------- | -------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| `address` | string | null | No | — | A textual representation of the client’s physical address. May include new line characters. |
| `currency` | string | null | No | — | The currency used by the client. If not provided, the company’s currency will be used. See a list of supported currencies |
| `is_active` | boolean | null | No | — | Whether the client is active, or archived. Defaults to true. |
| `name` | string | null | Yes | — | A textual description of the client. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": [
"string",
"null"
],
"description": "A textual representation of the client’s physical address. May include new line characters."
},
"currency": {
"type": [
"string",
"null"
],
"description": "The currency used by the client. If not provided, the company’s currency will be used. See a list of supported currencies"
},
"is_active": {
"type": [
"boolean",
"null"
],
"description": "Whether the client is active, or archived. Defaults to true."
},
"name": {
"type": [
"string",
"null"
],
"description": "A textual description of the client."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## harvest\_people\_create\_contact
Create a contact
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------------- | ------- | -------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `client_id` | integer | null | Yes | — | The ID of the client associated with this contact. |
| `email` | string | null | No | — | The contact’s email address. |
| `fax` | string | null | No | — | The contact’s fax number. |
| `first_name` | string | null | Yes | — | The first name of the contact. |
| `invoice_recipient_status` | string | null | No | — | The contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none. |
| `last_name` | string | null | No | — | The last name of the contact. |
| `phone_mobile` | string | null | No | — | The contact’s mobile phone number. |
| `phone_office` | string | null | No | — | The contact’s office phone number. |
| `title` | string | null | No | — | The title of the contact. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"client_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the client associated with this contact."
},
"email": {
"type": [
"string",
"null"
],
"description": "The contact’s email address."
},
"fax": {
"type": [
"string",
"null"
],
"description": "The contact’s fax number."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "The first name of the contact."
},
"invoice_recipient_status": {
"type": [
"string",
"null"
],
"description": "The contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The last name of the contact."
},
"phone_mobile": {
"type": [
"string",
"null"
],
"description": "The contact’s mobile phone number."
},
"phone_office": {
"type": [
"string",
"null"
],
"description": "The contact’s office phone number."
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the contact."
}
},
"required": [
"PCID",
"client_id",
"first_name"
]
}
```
***
## harvest\_people\_create\_cost\_rate
Create a cost rate
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------ | ------ | -------- | ------- | ----------- | -------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id | |
| `amount` | number | null | Yes | — | The amount of the cost rate. |
| `start_date` | string | null | No | — | The date the cost rate is effective. Cannot be a date in the future. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"amount": {
"type": [
"number",
"null"
],
"description": "The amount of the cost rate."
},
"start_date": {
"type": [
"string",
"null"
],
"description": "The date the cost rate is effective. Cannot be a date in the future."
}
},
"required": [
"PCID",
"userId",
"amount"
]
}
```
***
## harvest\_people\_create\_role
Create a role
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------- | ---------- | -------- | ------- | ------------------------------------------- | --------------------- |
| `name` | string | null | Yes | — | The name of the role. |
| `user_ids` | integer\[] | No | — | The IDs of the users assigned to this role. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the role."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the users assigned to this role."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## harvest\_people\_create\_user
Create a user
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `access_roles` | string\[] | No | — | Access role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project\_creator, billable\_rates\_manager, managed\_projects\_invoice\_drafter, managed\_projects\_invoice\_manager, client\_and\_task\_manager, time\_and\_expenses\_manager, estimates\_manager. | |
| `cost_rate` | number | null | No | — | The cost rate to use for this user when calculating a project’s costs vs billable amount. Defaults to 0. |
| `default_hourly_rate` | number | null | No | — | The billable rate to use for this user when they are added to a project. Defaults to 0. |
| `email` | string | null | Yes | — | The email address of the user. |
| `first_name` | string | null | Yes | — | The first name of the user. |
| `has_access_to_all_future_projects` | boolean | null | No | — | Whether the user should be automatically added to future projects. Defaults to false. |
| `is_active` | boolean | null | No | — | Whether the user is active or archived. Defaults to true. |
| `is_contractor` | boolean | null | No | — | Whether the user is a contractor or an employee. Defaults to false. |
| `last_name` | string | null | Yes | — | The last name of the user. |
| `roles` | string\[] | No | — | Descriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest. | |
| `timezone` | string | null | No | — | The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones. |
| `weekly_capacity` | integer | null | No | — | The number of hours per week this person is available to work in seconds. Defaults to 126000 seconds (35 hours). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"access_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project_creator, billable_rates_manager, managed_projects_invoice_drafter, managed_projects_invoice_manager, client_and_task_manager, time_and_expenses_manager, estimates_manager."
},
"cost_rate": {
"type": [
"number",
"null"
],
"description": "The cost rate to use for this user when calculating a project’s costs vs billable amount. Defaults to 0."
},
"default_hourly_rate": {
"type": [
"number",
"null"
],
"description": "The billable rate to use for this user when they are added to a project. Defaults to 0."
},
"email": {
"type": [
"string",
"null"
],
"description": "The email address of the user."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "The first name of the user."
},
"has_access_to_all_future_projects": {
"type": [
"boolean",
"null"
],
"description": "Whether the user should be automatically added to future projects. Defaults to false."
},
"is_active": {
"type": [
"boolean",
"null"
],
"description": "Whether the user is active or archived. Defaults to true."
},
"is_contractor": {
"type": [
"boolean",
"null"
],
"description": "Whether the user is a contractor or an employee. Defaults to false."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The last name of the user."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Descriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones."
},
"weekly_capacity": {
"type": [
"integer",
"null"
],
"description": "The number of hours per week this person is available to work in seconds. Defaults to 126000 seconds (35 hours)."
}
},
"required": [
"PCID",
"email",
"first_name",
"last_name"
]
}
```
***
## harvest\_people\_delete\_client
Delete a client
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `clientId` | string | Yes | — | Client Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clientId": {
"type": "string",
"description": "Client Id"
}
},
"required": [
"PCID",
"clientId"
]
}
```
***
## harvest\_people\_delete\_contact
Delete a contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `contactId` | string | Yes | — | Contact Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "Contact Id"
}
},
"required": [
"PCID",
"contactId"
]
}
```
***
## harvest\_people\_delete\_role
Delete a role
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `roleId` | string | Yes | — | Role Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roleId": {
"type": "string",
"description": "Role Id"
}
},
"required": [
"PCID",
"roleId"
]
}
```
***
## harvest\_people\_delete\_user
Delete a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_list\_active\_project\_assignments
List active project assignments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id |
| `updated_since` | string | No | — | Only return project assignments that have been updated since the given date and time. |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"updated_since": {
"type": "string",
"description": "Only return project assignments that have been updated since the given date and time."
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_list\_active\_project\_assignments\_for\_the\_currently\_authenticated\_user
List active project assignments for the currently authenticated user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_list\_assigned\_teammates\_for\_specific\_user
List all assigned teammates for a specific user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_list\_billable\_rates\_for\_specific\_user
List all billable rates for a specific user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_list\_clients
List all clients
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `is_active` | boolean | No | — | Pass true to only return active clients and false to return inactive clients. |
| `updated_since` | string | No | — | Only return clients that have been updated since the given date and time. |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"is_active": {
"type": "boolean",
"description": "Pass true to only return active clients and false to return inactive clients."
},
"updated_since": {
"type": "string",
"description": "Only return clients that have been updated since the given date and time."
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_list\_contacts
List all contacts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | integer | No | — | Only return contacts belonging to the client with the given ID. |
| `updated_since` | string | No | — | Only return contacts that have been updated since the given date and time. |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"client_id": {
"type": "integer",
"description": "Only return contacts belonging to the client with the given ID."
},
"updated_since": {
"type": "string",
"description": "Only return contacts that have been updated since the given date and time."
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_list\_cost\_rates\_for\_specific\_user
List all cost rates for a specific user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_list\_roles
List all roles
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_list\_users
List all users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `is_active` | boolean | No | — | Pass true to only return active users and false to return inactive users. |
| `updated_since` | string | No | — | Only return users that have been updated since the given date and time. |
| `page` | integer | No | — | DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1) |
| `cursor` | string | No | — | Pagination cursor |
| `per_page` | integer | No | — | The number of records to return per page. Can range between 1 and 2000. (Default: 2000) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"is_active": {
"type": "boolean",
"description": "Pass true to only return active users and false to return inactive users."
},
"updated_since": {
"type": "string",
"description": "Only return users that have been updated since the given date and time."
},
"page": {
"type": "integer",
"description": "DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)"
},
"cursor": {
"type": "string",
"description": "Pagination cursor"
},
"per_page": {
"type": "integer",
"description": "The number of records to return per page. Can range between 1 and 2000. (Default: 2000)"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_retrieve\_billable\_rate
Retrieve a billable rate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------- |
| `userId` | string | Yes | — | User Id |
| `billableRateId` | string | Yes | — | Billable Rate Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"billableRateId": {
"type": "string",
"description": "Billable Rate Id"
}
},
"required": [
"PCID",
"userId",
"billableRateId"
]
}
```
***
## harvest\_people\_retrieve\_client
Retrieve a client
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `clientId` | string | Yes | — | Client Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clientId": {
"type": "string",
"description": "Client Id"
}
},
"required": [
"PCID",
"clientId"
]
}
```
***
## harvest\_people\_retrieve\_company
Retrieve a company
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_retrieve\_contact
Retrieve a contact
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `contactId` | string | Yes | — | Contact Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "Contact Id"
}
},
"required": [
"PCID",
"contactId"
]
}
```
***
## harvest\_people\_retrieve\_cost\_rate
Retrieve a cost rate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------ |
| `userId` | string | Yes | — | User Id |
| `costRateId` | string | Yes | — | Cost Rate Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"costRateId": {
"type": "string",
"description": "Cost Rate Id"
}
},
"required": [
"PCID",
"userId",
"costRateId"
]
}
```
***
## harvest\_people\_retrieve\_role
Retrieve a role
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `roleId` | string | Yes | — | Role Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roleId": {
"type": "string",
"description": "Role Id"
}
},
"required": [
"PCID",
"roleId"
]
}
```
***
## harvest\_people\_retrieve\_the\_currently\_authenticated\_user
Retrieve the currently authenticated user
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_retrieve\_user
Retrieve a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_update\_client
Update a client
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------- | ------- | -------- | ------- | ----------- | ------------------------------------------------------------------------------------------- |
| `clientId` | string | Yes | — | Client Id | |
| `address` | string | null | No | — | A textual representation of the client’s physical address. May include new line characters. |
| `currency` | string | null | No | — | The currency used by the client. See a list of supported currencies |
| `is_active` | boolean | null | No | — | Whether the client is active, or archived. |
| `name` | string | null | No | — | A textual description of the client. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clientId": {
"type": "string",
"description": "Client Id"
},
"address": {
"type": [
"string",
"null"
],
"description": "A textual representation of the client’s physical address. May include new line characters."
},
"currency": {
"type": [
"string",
"null"
],
"description": "The currency used by the client. See a list of supported currencies"
},
"is_active": {
"type": [
"boolean",
"null"
],
"description": "Whether the client is active, or archived."
},
"name": {
"type": [
"string",
"null"
],
"description": "A textual description of the client."
}
},
"required": [
"PCID",
"clientId"
]
}
```
***
## harvest\_people\_update\_company
Update a company
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------ | ------- | -------- | ------- | ----------- | ------------------------------------------------------------ |
| `wants_timestamp_timers` | boolean | null | No | — | Whether time is tracked via duration or start and end times. |
| `weekly_capacity` | integer | null | No | — | The weekly capacity in seconds. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"wants_timestamp_timers": {
"type": [
"boolean",
"null"
],
"description": "Whether time is tracked via duration or start and end times."
},
"weekly_capacity": {
"type": [
"integer",
"null"
],
"description": "The weekly capacity in seconds."
}
},
"required": [
"PCID"
]
}
```
***
## harvest\_people\_update\_contact
Update a contact
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------------- | ------- | -------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `contactId` | string | Yes | — | Contact Id | |
| `client_id` | integer | null | No | — | The ID of the client associated with this contact. |
| `email` | string | null | No | — | The contact’s email address. |
| `fax` | string | null | No | — | The contact’s fax number. |
| `first_name` | string | null | No | — | The first name of the contact. |
| `invoice_recipient_status` | string | null | No | — | The contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none. |
| `last_name` | string | null | No | — | The last name of the contact. |
| `phone_mobile` | string | null | No | — | The contact’s mobile phone number. |
| `phone_office` | string | null | No | — | The contact’s office phone number. |
| `title` | string | null | No | — | The title of the contact. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "Contact Id"
},
"client_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the client associated with this contact."
},
"email": {
"type": [
"string",
"null"
],
"description": "The contact’s email address."
},
"fax": {
"type": [
"string",
"null"
],
"description": "The contact’s fax number."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "The first name of the contact."
},
"invoice_recipient_status": {
"type": [
"string",
"null"
],
"description": "The contact’s default role on the client’s invoices (Invoice email default in the web UI). One of none, recipient, cc, or bcc. Defaults to none."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The last name of the contact."
},
"phone_mobile": {
"type": [
"string",
"null"
],
"description": "The contact’s mobile phone number."
},
"phone_office": {
"type": [
"string",
"null"
],
"description": "The contact’s office phone number."
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the contact."
}
},
"required": [
"PCID",
"contactId"
]
}
```
***
## harvest\_people\_update\_role
Update a role
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------- | ---------- | -------- | ------- | ------------------------------------------- | --------------------- |
| `roleId` | string | Yes | — | Role Id | |
| `name` | string | null | No | — | The name of the role. |
| `user_ids` | integer\[] | No | — | The IDs of the users assigned to this role. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roleId": {
"type": "string",
"description": "Role Id"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the role."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of the users assigned to this role."
}
},
"required": [
"PCID",
"roleId"
]
}
```
***
## harvest\_people\_update\_user
Update a user
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User Id | |
| `access_roles` | string\[] | No | — | Access role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project\_creator, billable\_rates\_manager, managed\_projects\_invoice\_drafter, managed\_projects\_invoice\_manager, client\_and\_task\_manager, time\_and\_expenses\_manager, estimates\_manager. | |
| `email` | string | null | No | — | The email address of the user. Can’t be updated if the user is inactive. |
| `first_name` | string | null | No | — | The first name of the user. Can’t be updated if the user is inactive. |
| `has_access_to_all_future_projects` | boolean | null | No | — | Whether the user should be automatically added to future projects. |
| `is_active` | boolean | null | No | — | Whether the user is active or archived. |
| `is_contractor` | boolean | null | No | — | Whether the user is a contractor or an employee. |
| `last_name` | string | null | No | — | The last name of the user. Can’t be updated if the user is inactive. |
| `roles` | string\[] | No | — | Descriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest. | |
| `timezone` | string | null | No | — | The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones. |
| `weekly_capacity` | integer | null | No | — | The number of hours per week this person is available to work in seconds. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"access_roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access role(s) that determine the user’s permissions in Harvest. Possible values: administrator, manager or member. Users with the manager role can additionally be granted one or more of these roles: project_creator, billable_rates_manager, managed_projects_invoice_drafter, managed_projects_invoice_manager, client_and_task_manager, time_and_expenses_manager, estimates_manager."
},
"email": {
"type": [
"string",
"null"
],
"description": "The email address of the user. Can’t be updated if the user is inactive."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "The first name of the user. Can’t be updated if the user is inactive."
},
"has_access_to_all_future_projects": {
"type": [
"boolean",
"null"
],
"description": "Whether the user should be automatically added to future projects."
},
"is_active": {
"type": [
"boolean",
"null"
],
"description": "Whether the user is active or archived."
},
"is_contractor": {
"type": [
"boolean",
"null"
],
"description": "Whether the user is a contractor or an employee."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The last name of the user. Can’t be updated if the user is inactive."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Descriptive names of the business roles assigned to this person. They can be used for filtering reports, and have no effect in their permissions in Harvest."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones."
},
"weekly_capacity": {
"type": [
"integer",
"null"
],
"description": "The number of hours per week this person is available to work in seconds."
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## harvest\_people\_update\_user\_assigned\_teammates
Update a user’s assigned teammates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ---------- | -------- | ------- | ---------------------------------------------------- |
| `userId` | string | Yes | — | User Id |
| `teammate_ids` | integer\[] | Yes | — | Full list of user IDs to be assigned to the Manager. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"teammate_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Full list of user IDs to be assigned to the Manager."
}
},
"required": [
"PCID",
"userId",
"teammate_ids"
]
}
```