# folk

> Work with your folk CRM: find, add, change and remove people and companies, put them in groups, write notes on them and manage tasks.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/folk

## Actions

### Create company

Add a company. If a company with this name already exists, folk updates it with the fields given instead of adding a second.

**Inputs**

- Name (`name`, text, required): The company's name.
- Description (`description`, text): A short description.
- Industry (`industry`, text): The industry the company works in.
- Employees (`employee_range`, text): How many people work there. One of: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000` (501-1,000), `1001-5000` (1,001-5,000), `5001-10000` (5,001-10,000), `10000+` (More than 10,000).
- Founded in (`foundation_year`, number): The year the company was founded, such as 2015. From 1000 to 2100.
- Funding raised (USD) (`funding_raised`, number): The total funding raised, in US dollars. At least 0.
- Last funding round (`last_funding_date`, date): The day of the last funding round.
- Email addresses (`emails`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Phone numbers (`phones`, list): One per row, with the country code. The first is the primary number. On an update, the list replaces the current one.
- Links (`urls`, list): Websites and profiles, one per row. The first is the primary link. On an update, the list replaces the current one.
- Addresses (`addresses`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Add to groups (`group_ids`, list): The groups to put them in. They stay in any group they are in.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "company": {
    "addresses": [],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [],
    "employeeRange": "11-50",
    "foundationYear": "2015",
    "fundingRaised": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
    "industry": "Software",
    "lastFundingDate": null,
    "name": "Acme",
    "phones": [],
    "urls": [
      "https://acme.example.com"
    ]
  }
}
```

### Create note

Write a note on a person or company.

**Inputs**

- Person or company ID (`entity_id`, text, required): The id of the person (per_) or company (com_) it is about.
- Note (`content`, text, required): The text of the note. Plain text or Markdown.
- Who can see it (`visibility`, text): Everyone in the workspace, or only the key's owner. One of: `public` (Everyone in the workspace (default)), `private` (Only me).

**Outputs**

- `note` (object): The note created

**Example output**

```json
{
  "note": {
    "author": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b",
      "type": "user"
    },
    "content": "Met at the conference.",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "not_0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
    "parentNote": null,
    "visibility": "public"
  }
}
```

### Create person

Add a person, with a first name, last name or email at least, optionally at companies and in groups.

**Inputs**

- First name (`first_name`, text): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Job title (`job_title`, text): Their job title.
- Description (`description`, text): A short description.
- Birthday (`birthday`, date): Their birthday.
- Gender (`gender`, text): Their gender, as folk records it. One of: `Female`, `Male`, `Other`, `Unknown`.
- Email addresses (`emails`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Phone numbers (`phones`, list): One per row, with the country code. The first is the primary number. On an update, the list replaces the current one.
- Links (`urls`, list): Websites and profiles, one per row. The first is the primary link. On an update, the list replaces the current one.
- Addresses (`addresses`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Companies (`company_names`, list): The names of the companies they work at, one per row; the first is the primary company. A company that does not exist yet is created.
- Add to groups (`group_ids`, list): The groups to put them in. They stay in any group they are in.

**Outputs**

- `person` (object): The person created

**Example output**

```json
{
  "person": {
    "addresses": [],
    "birthday": null,
    "companies": [
      {
        "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
        "name": "Acme"
      }
    ],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [
      "ada@example.com"
    ],
    "firstName": "Ada",
    "fullName": "Ada Lovelace",
    "gender": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67",
    "jobTitle": "Mathematician",
    "lastName": "Lovelace",
    "phones": [],
    "urls": []
  }
}
```

### Create task

Create a task about a person or company, due on a day. It is assigned to the key's owner unless you choose others.

**Inputs**

- Person or company ID (`entity_id`, text, required): The id of the person (per_) or company (com_) it is about.
- Title (`title`, text, required): What needs doing.
- Due date (`due_date`, date, required): The day it is due.
- Due time (`due_time`, time): The time of day it is due. Leave empty for no time.
- Description (`description`, text): Details of the task.
- Repeats (`repeats`, text): How often the task repeats. One of: `none` (Does not repeat (default)), `weekday` (Every weekday), `weekly` (Every week), `biweekly` (Every two weeks), `monthly` (Every month), `quarterly` (Every three months), `yearly` (Every year).
- Assign to (`assignee_ids`, list): Who the task is for. Leave empty to assign it to the key's owner.
- Visible to the whole workspace (`visible_to_all`, true/false): On to show the task to everyone; off to show it only to those assigned.

**Outputs**

- `task` (object): The task created

**Example output**

```json
{
  "task": {
    "assignedUsers": [
      {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      }
    ],
    "completedAt": null,
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "description": null,
    "dueAt": "2026-11-02",
    "dueTime": null,
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
    "isPublic": true,
    "recurrenceFrequency": null,
    "title": "Send the proposal",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}
```

### Delete company

Delete a company from folk.

**Inputs**

- Company ID (`company_id`, text, required): The company's id (starts with com_), from 'List companies' or an earlier step.

**Outputs**

- `company_id` (text): The company deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "company_id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
  "deleted": true
}
```

### Delete note

Delete a note.

**Inputs**

- Note ID (`note_id`, text, required): The note's id, from 'List notes' or 'Create note'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `note_id` (text): The note deleted

**Example output**

```json
{
  "deleted": true,
  "note_id": "not_0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e"
}
```

### Delete person

Delete a person from folk.

**Inputs**

- Person ID (`person_id`, text, required): The person's id (starts with per_), from 'List people' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `person_id` (text): The person deleted

**Example output**

```json
{
  "deleted": true,
  "person_id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
}
```

### Delete task

Delete a task.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `task_id` (text): The task deleted

**Example output**

```json
{
  "deleted": true,
  "task_id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
}
```

### Get company

Get one company with its industry, size, links and groups.

**Inputs**

- Company ID (`company_id`, text, required): The company's id (starts with com_), from 'List companies' or an earlier step.

**Outputs**

- `company` (object): The company

**Example output**

```json
{
  "company": {
    "addresses": [],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [],
    "employeeRange": "11-50",
    "foundationYear": "2015",
    "fundingRaised": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
    "industry": "Software",
    "lastFundingDate": null,
    "name": "Acme",
    "phones": [],
    "urls": [
      "https://acme.example.com"
    ]
  }
}
```

### Get current user

Get the folk user the API key belongs to: id, name and email.

**Inputs**: None.

**Outputs**

- `user` (object): The connected user

**Example output**

```json
{
  "user": {
    "email": "jo@example.com",
    "fullName": "Jo Bloggs",
    "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
  }
}
```

### Get note

Get one note with its text, author and the record it is on.

**Inputs**

- Note ID (`note_id`, text, required): The note's id, from 'List notes' or 'Create note'.

**Outputs**

- `note` (object): The note

**Example output**

```json
{
  "note": {
    "author": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b",
      "type": "user"
    },
    "content": "Met at the conference.",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "not_0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
    "parentNote": null,
    "visibility": "public"
  }
}
```

### Get person

Get one person with their emails, phones, companies and groups.

**Inputs**

- Person ID (`person_id`, text, required): The person's id (starts with per_), from 'List people' or an earlier step.

**Outputs**

- `person` (object): The person

**Example output**

```json
{
  "person": {
    "addresses": [],
    "birthday": null,
    "companies": [
      {
        "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
        "name": "Acme"
      }
    ],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [
      "ada@example.com"
    ],
    "firstName": "Ada",
    "fullName": "Ada Lovelace",
    "gender": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67",
    "jobTitle": "Mathematician",
    "lastName": "Lovelace",
    "phones": [],
    "urls": []
  }
}
```

### Get task

Get one task with its due day, assignees and the record it is about.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "assignedUsers": [
      {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      }
    ],
    "completedAt": null,
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "description": null,
    "dueAt": "2026-11-02",
    "dueTime": null,
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
    "isPublic": true,
    "recurrenceFrequency": null,
    "title": "Send the proposal",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}
```

### List companies

List companies, filtered by name, industry, website, group or creation day. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Name contains (`name_contains`, text): Only companies whose name contains this.
- Industry contains (`industry_contains`, text): Only companies whose industry contains this.
- Website contains (`website_contains`, text): Only companies with a link containing this, such as acme.com.
- Group (`group_id`, text): Only those in this group.
- Created after (`created_after`, date): Only those created after this day.
- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `companies` (list): The companies
- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last

**Example output**

```json
{
  "companies": [
    {
      "addresses": [],
      "createdAt": "2026-10-15T09:00:00.000Z",
      "createdBy": {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      },
      "customFieldValues": {},
      "description": "",
      "emails": [],
      "employeeRange": "11-50",
      "foundationYear": "2015",
      "fundingRaised": null,
      "groups": [
        {
          "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "name": "Clients"
        }
      ],
      "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
      "industry": "Software",
      "lastFundingDate": null,
      "name": "Acme",
      "phones": [],
      "urls": [
        "https://acme.example.com"
      ]
    }
  ],
  "count": 1,
  "next_cursor": ""
}
```

### List groups

List the groups of the workspace. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many are in this page
- `groups` (list): The groups
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last

**Example output**

```json
{
  "count": 1,
  "groups": [
    {
      "createdBy": "usr_55175e81-9a52-4ac3-930e-82792c23499b",
      "emoji": "\ud83e\udd1d",
      "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
      "name": "Clients",
      "visibility": "public"
    }
  ],
  "next_cursor": ""
}
```

### List notes

List notes, on one person or company, containing some text, or written in a time range. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Person or company ID (`entity_id`, text): Only notes on this person (per_) or company (com_).
- Contains (`search`, text): Only notes whose text contains this.
- Written after (`created_after`, date and time): Only notes written after this time.
- Written before (`created_before`, date and time): Only notes written before this time.
- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last
- `notes` (list): The notes

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "notes": [
    {
      "author": {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b",
        "type": "user"
      },
      "content": "Met at the conference.",
      "createdAt": "2026-10-15T09:00:00.000Z",
      "entity": {
        "entityType": "person",
        "fullName": "Ada Lovelace",
        "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
      },
      "id": "not_0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
      "parentNote": null,
      "visibility": "public"
    }
  ]
}
```

### List people

List people, filtered by name, email, job title, group, company or creation day. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Name contains (`name_contains`, text): Only people whose full name contains this.
- Email contains (`email_contains`, text): Only people with an email address containing this, such as an address or @company.com.
- Job title contains (`job_title_contains`, text): Only people whose job title contains this.
- Group (`group_id`, text): Only those in this group.
- Company ID (`company_id`, text): Only people at this company (an id starting with com_).
- Created after (`created_after`, date): Only those created after this day.
- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last
- `people` (list): The people

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "people": [
    {
      "addresses": [],
      "birthday": null,
      "companies": [
        {
          "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
          "name": "Acme"
        }
      ],
      "createdAt": "2026-10-15T09:00:00.000Z",
      "createdBy": {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      },
      "customFieldValues": {},
      "description": "",
      "emails": [
        "ada@example.com"
      ],
      "firstName": "Ada",
      "fullName": "Ada Lovelace",
      "gender": null,
      "groups": [
        {
          "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "name": "Clients"
        }
      ],
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67",
      "jobTitle": "Mathematician",
      "lastName": "Lovelace",
      "phones": [],
      "urls": []
    }
  ]
}
```

### List tasks

List tasks, by status, assignee, person or company, or due day. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Status (`status`, text): Which tasks to include. One of: `all` (All tasks (default)), `open` (Not done yet), `done`.
- Only my tasks (`only_mine`, true/false): On to list only tasks assigned to the key's owner.
- Assigned to (`assignee_id`, text): Only tasks assigned to this user.
- Person or company ID (`entity_id`, text): Only tasks about this person (per_) or company (com_).
- Due after (`due_after`, date): Only tasks due after this day.
- Due before (`due_before`, date): Only tasks due before this day.
- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last
- `tasks` (list): The tasks

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "tasks": [
    {
      "assignedUsers": [
        {
          "email": "jo@example.com",
          "fullName": "Jo Bloggs",
          "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
        }
      ],
      "completedAt": null,
      "createdAt": "2026-10-15T09:00:00.000Z",
      "createdBy": {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      },
      "description": null,
      "dueAt": "2026-11-02",
      "dueTime": null,
      "entity": {
        "entityType": "person",
        "fullName": "Ada Lovelace",
        "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
      },
      "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
      "isPublic": true,
      "recurrenceFrequency": null,
      "title": "Send the proposal",
      "updatedAt": "2026-10-15T09:00:00.000Z"
    }
  ]
}
```

### List users

List the users of the workspace, for assigning tasks. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 100. folk's default is 20. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many are in this page
- `next_cursor` (text): Pass as 'cursor' to get the next page; empty on the last
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "next_cursor": "",
  "users": [
    {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    }
  ]
}
```

### Mark task done

Mark a task as done, now or at the time you choose.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.
- Done at (`completed_at`, date and time): When it was done. Leave empty for now.

**Outputs**

- `task` (object): The task, now done

**Example output**

```json
{
  "task": {
    "assignedUsers": [
      {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      }
    ],
    "completedAt": "2026-10-16T09:00:00.000Z",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "description": null,
    "dueAt": "2026-11-02",
    "dueTime": null,
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
    "isPublic": true,
    "recurrenceFrequency": null,
    "title": "Send the proposal",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}
```

### Mark task to do

Mark a finished task as to do again.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.

**Outputs**

- `task` (object): The task, open again

**Example output**

```json
{
  "task": {
    "assignedUsers": [
      {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      }
    ],
    "completedAt": null,
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "description": null,
    "dueAt": "2026-11-02",
    "dueTime": null,
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
    "isPublic": true,
    "recurrenceFrequency": null,
    "title": "Send the proposal",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}
```

### Update company

Change the fields given on a company. Fields left empty stay as they are; a list given replaces the company's list.

**Inputs**

- Company ID (`company_id`, text, required): The company's id (starts with com_), from 'List companies' or an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Description (`description`, text): A short description.
- Industry (`industry`, text): The industry the company works in.
- Employees (`employee_range`, text): How many people work there. One of: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000` (501-1,000), `1001-5000` (1,001-5,000), `5001-10000` (5,001-10,000), `10000+` (More than 10,000).
- Founded in (`foundation_year`, number): The year the company was founded, such as 2015. From 1000 to 2100.
- Funding raised (USD) (`funding_raised`, number): The total funding raised, in US dollars. At least 0.
- Last funding round (`last_funding_date`, date): The day of the last funding round.
- Email addresses (`emails`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Phone numbers (`phones`, list): One per row, with the country code. The first is the primary number. On an update, the list replaces the current one.
- Links (`urls`, list): Websites and profiles, one per row. The first is the primary link. On an update, the list replaces the current one.
- Addresses (`addresses`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Add to groups (`group_ids`, list): The groups to put them in. They stay in any group they are in.

**Outputs**

- `company` (object): The company, updated

**Example output**

```json
{
  "company": {
    "addresses": [],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [],
    "employeeRange": "11-50",
    "foundationYear": "2015",
    "fundingRaised": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
    "industry": "Software",
    "lastFundingDate": null,
    "name": "Acme",
    "phones": [],
    "urls": [
      "https://acme.example.com"
    ]
  }
}
```

### Update note

Change a note's text or who can see it. Fields left empty stay as they are.

**Inputs**

- Note ID (`note_id`, text, required): The note's id, from 'List notes' or 'Create note'.
- Note (`content`, text): The new text. Leave empty to keep it.
- Who can see it (`visibility`, text): Leave empty to keep it. One of: `public` (Everyone in the workspace (default)), `private` (Only me).

**Outputs**

- `note` (object): The note, updated

**Example output**

```json
{
  "note": {
    "author": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b",
      "type": "user"
    },
    "content": "Met at the conference.",
    "createdAt": "2026-10-15T09:00:00.000Z",
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "not_0b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
    "parentNote": null,
    "visibility": "public"
  }
}
```

### Update person

Change the fields given on a person. Fields left empty stay as they are; a list given replaces the person's list.

**Inputs**

- Person ID (`person_id`, text, required): The person's id (starts with per_), from 'List people' or an earlier step.
- First name (`first_name`, text): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Job title (`job_title`, text): Their job title.
- Description (`description`, text): A short description.
- Birthday (`birthday`, date): Their birthday.
- Gender (`gender`, text): Their gender, as folk records it. One of: `Female`, `Male`, `Other`, `Unknown`.
- Email addresses (`emails`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Phone numbers (`phones`, list): One per row, with the country code. The first is the primary number. On an update, the list replaces the current one.
- Links (`urls`, list): Websites and profiles, one per row. The first is the primary link. On an update, the list replaces the current one.
- Addresses (`addresses`, list): One per row. The first is the primary address. On an update, the list replaces the current one.
- Companies (`company_names`, list): The names of the companies they work at, one per row; the first is the primary company. A company that does not exist yet is created.
- Add to groups (`group_ids`, list): The groups to put them in. They stay in any group they are in.

**Outputs**

- `person` (object): The person, updated

**Example output**

```json
{
  "person": {
    "addresses": [],
    "birthday": null,
    "companies": [
      {
        "id": "com_f3855422-6740-4e6a-aa5e-449ac77047d0",
        "name": "Acme"
      }
    ],
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "customFieldValues": {},
    "description": "",
    "emails": [
      "ada@example.com"
    ],
    "firstName": "Ada",
    "fullName": "Ada Lovelace",
    "gender": null,
    "groups": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Clients"
      }
    ],
    "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67",
    "jobTitle": "Mathematician",
    "lastName": "Lovelace",
    "phones": [],
    "urls": []
  }
}
```

### Update task

Change the fields given on a task. Fields left empty stay as they are.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or 'Create task'.
- Title (`title`, text): A new title. Leave empty to keep it.
- Due date (`due_date`, date): A new due day. Leave empty to keep it.
- Due time (`due_time`, time): The time of day it is due. Leave empty for no time.
- Description (`description`, text): Details of the task.
- Repeats (`repeats`, text): How often the task repeats. One of: `none` (Does not repeat (default)), `weekday` (Every weekday), `weekly` (Every week), `biweekly` (Every two weeks), `monthly` (Every month), `quarterly` (Every three months), `yearly` (Every year).
- Assign to (`assignee_ids`, list): Who the task is for. Leave empty to assign it to the key's owner.
- Visible to the whole workspace (`visible_to_all`, true/false): On to show the task to everyone; off to show it only to those assigned.

**Outputs**

- `task` (object): The task, updated

**Example output**

```json
{
  "task": {
    "assignedUsers": [
      {
        "email": "jo@example.com",
        "fullName": "Jo Bloggs",
        "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
      }
    ],
    "completedAt": null,
    "createdAt": "2026-10-15T09:00:00.000Z",
    "createdBy": {
      "email": "jo@example.com",
      "fullName": "Jo Bloggs",
      "id": "usr_55175e81-9a52-4ac3-930e-82792c23499b"
    },
    "description": null,
    "dueAt": "2026-11-02",
    "dueTime": null,
    "entity": {
      "entityType": "person",
      "fullName": "Ada Lovelace",
      "id": "per_05837e2d-9bf7-4f17-8729-e95f1be4de67"
    },
    "id": "tsk_7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
    "isPublic": true,
    "recurrenceFrequency": null,
    "title": "Send the proposal",
    "updatedAt": "2026-10-15T09:00:00.000Z"
  }
}
```
