/harvest-people | Type: Application | PCID required: Yes
Tools
harvest_people_create_billable_rate
Create a billable rate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
amount | number | Yes | — | The amount of the billable rate. |
start_date | string | No | — | The date the billable rate is effective. Cannot be a date in the future. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"amount": {
"type": "number",
"description": "The amount of the billable rate."
},
"start_date": {
"type": "string",
"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 | No | — | A textual representation of the client’s physical address. May include new line characters. |
currency | string | 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 | No | — | Whether the client is active, or archived. Defaults to true. |
name | string | Yes | — | A textual description of the client. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "string",
"description": "A textual representation of the client’s physical address. May include new line characters."
},
"currency": {
"type": "string",
"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",
"description": "Whether the client is active, or archived. Defaults to true."
},
"name": {
"type": "string",
"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 | Yes | — | The ID of the client associated with this contact. |
email | string | No | — | The contact’s email address. |
fax | string | No | — | The contact’s fax number. |
first_name | string | Yes | — | The first name of the contact. |
invoice_recipient_status | string | 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 | No | — | The last name of the contact. |
phone_mobile | string | No | — | The contact’s mobile phone number. |
phone_office | string | No | — | The contact’s office phone number. |
title | string | No | — | The title of the contact. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"client_id": {
"type": "integer",
"description": "The ID of the client associated with this contact."
},
"email": {
"type": "string",
"description": "The contact’s email address."
},
"fax": {
"type": "string",
"description": "The contact’s fax number."
},
"first_name": {
"type": "string",
"description": "The first name of the contact."
},
"invoice_recipient_status": {
"type": "string",
"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",
"description": "The last name of the contact."
},
"phone_mobile": {
"type": "string",
"description": "The contact’s mobile phone number."
},
"phone_office": {
"type": "string",
"description": "The contact’s office phone number."
},
"title": {
"type": "string",
"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 | Yes | — | The amount of the cost rate. |
start_date | string | No | — | The date the cost rate is effective. Cannot be a date in the future. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"amount": {
"type": "number",
"description": "The amount of the cost rate."
},
"start_date": {
"type": "string",
"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 | Yes | — | The name of the role. |
user_ids | integer[] | No | — | The IDs of the users assigned to this role. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"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 | 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 | No | — | The billable rate to use for this user when they are added to a project. Defaults to 0. |
email | string | Yes | — | The email address of the user. |
first_name | string | Yes | — | The first name of the user. |
has_access_to_all_future_projects | boolean | No | — | Whether the user should be automatically added to future projects. Defaults to false. |
is_active | boolean | No | — | Whether the user is active or archived. Defaults to true. |
is_contractor | boolean | No | — | Whether the user is a contractor or an employee. Defaults to false. |
last_name | string | 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 | No | — | The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones. |
weekly_capacity | integer | No | — | The number of hours per week this person is available to work in seconds. Defaults to 126000 seconds (35 hours). |
Show inputSchema
Show inputSchema
{
"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",
"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",
"description": "The billable rate to use for this user when they are added to a project. Defaults to 0."
},
"email": {
"type": "string",
"description": "The email address of the user."
},
"first_name": {
"type": "string",
"description": "The first name of the user."
},
"has_access_to_all_future_projects": {
"type": "boolean",
"description": "Whether the user should be automatically added to future projects. Defaults to false."
},
"is_active": {
"type": "boolean",
"description": "Whether the user is active or archived. Defaults to true."
},
"is_contractor": {
"type": "boolean",
"description": "Whether the user is a contractor or an employee. Defaults to false."
},
"last_name": {
"type": "string",
"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",
"description": "The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones."
},
"weekly_capacity": {
"type": "integer",
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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) |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 companyShow inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 userShow inputSchema
Show inputSchema
{
"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 |
Show inputSchema
Show inputSchema
{
"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 | No | — | A textual representation of the client’s physical address. May include new line characters. |
currency | string | No | — | The currency used by the client. See a list of supported currencies |
is_active | boolean | No | — | Whether the client is active, or archived. |
name | string | No | — | A textual description of the client. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"clientId": {
"type": "string",
"description": "Client Id"
},
"address": {
"type": "string",
"description": "A textual representation of the client’s physical address. May include new line characters."
},
"currency": {
"type": "string",
"description": "The currency used by the client. See a list of supported currencies"
},
"is_active": {
"type": "boolean",
"description": "Whether the client is active, or archived."
},
"name": {
"type": "string",
"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 | No | — | Whether time is tracked via duration or start and end times. |
weekly_capacity | integer | No | — | The weekly capacity in seconds. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"wants_timestamp_timers": {
"type": "boolean",
"description": "Whether time is tracked via duration or start and end times."
},
"weekly_capacity": {
"type": "integer",
"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 | No | — | The ID of the client associated with this contact. |
email | string | No | — | The contact’s email address. |
fax | string | No | — | The contact’s fax number. |
first_name | string | No | — | The first name of the contact. |
invoice_recipient_status | string | 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 | No | — | The last name of the contact. |
phone_mobile | string | No | — | The contact’s mobile phone number. |
phone_office | string | No | — | The contact’s office phone number. |
title | string | No | — | The title of the contact. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "Contact Id"
},
"client_id": {
"type": "integer",
"description": "The ID of the client associated with this contact."
},
"email": {
"type": "string",
"description": "The contact’s email address."
},
"fax": {
"type": "string",
"description": "The contact’s fax number."
},
"first_name": {
"type": "string",
"description": "The first name of the contact."
},
"invoice_recipient_status": {
"type": "string",
"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",
"description": "The last name of the contact."
},
"phone_mobile": {
"type": "string",
"description": "The contact’s mobile phone number."
},
"phone_office": {
"type": "string",
"description": "The contact’s office phone number."
},
"title": {
"type": "string",
"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 | No | — | The name of the role. |
user_ids | integer[] | No | — | The IDs of the users assigned to this role. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"roleId": {
"type": "string",
"description": "Role Id"
},
"name": {
"type": "string",
"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 | No | — | The email address of the user. Can’t be updated if the user is inactive. |
first_name | string | No | — | The first name of the user. Can’t be updated if the user is inactive. |
has_access_to_all_future_projects | boolean | No | — | Whether the user should be automatically added to future projects. |
is_active | boolean | No | — | Whether the user is active or archived. |
is_contractor | boolean | No | — | Whether the user is a contractor or an employee. |
last_name | string | 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 | No | — | The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones. |
weekly_capacity | integer | No | — | The number of hours per week this person is available to work in seconds. |
Show inputSchema
Show inputSchema
{
"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",
"description": "The email address of the user. Can’t be updated if the user is inactive."
},
"first_name": {
"type": "string",
"description": "The first name of the user. Can’t be updated if the user is inactive."
},
"has_access_to_all_future_projects": {
"type": "boolean",
"description": "Whether the user should be automatically added to future projects."
},
"is_active": {
"type": "boolean",
"description": "Whether the user is active or archived."
},
"is_contractor": {
"type": "boolean",
"description": "Whether the user is a contractor or an employee."
},
"last_name": {
"type": "string",
"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",
"description": "The user’s timezone. Defaults to the company’s timezone. See a list of supported time zones."
},
"weekly_capacity": {
"type": "integer",
"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. |
Show inputSchema
Show inputSchema
{
"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"
]
}