# Vitally

> Work with your Vitally customer success data: create and update accounts, organizations and users with their traits, add notes, tasks and NPS responses, start projects from templates, and start workflows when accounts change, health scores move, accounts churn or tasks, notes, meetings and NPS responses come in.

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

## Actions

### Complete task

Mark a task as done, by a teammate if you like. A task already done is left as it is.

**Inputs**

- Task (`task_id`, text, required): The task's Vitally id, from 'Create task', 'List tasks' or a trigger.
- Completed by (`completed_by_id`, text): The teammate who did it.
- Completed at (`completed_at`, date and time): When it was done. Now if left empty.

**Outputs**

- `already_completed` (true/false): True when the task was already done, so nothing changed
- `task` (object): The task

**Example output**

```json
{
  "already_completed": false,
  "task": {
    "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "accountName": "Big Corp",
    "archivedAt": "",
    "assignedToEmail": "gilfoyle@example.com",
    "assignedToId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "assignedToName": "Bertram Gilfoyle",
    "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
    "categoryName": "Email",
    "completedAt": "2026-02-12T10:00:00Z",
    "completedById": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "createdAt": "2026-02-10T00:00:00.000Z",
    "description": "<p>An email with a survey has been sent to the account regarding their experience. Follow up with them!</p>",
    "dueDate": "2026-02-24",
    "externalId": "",
    "id": "4e0c5f2c-9b8d-4a5e-9d7c-6f1b0a9e8c75",
    "name": "Gather Feedback",
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "organizationName": "Big Corp Holdings",
    "projects": [
      {
        "id": "5f1d6a3d-0c9e-4b6f-8e8d-7a2c1b0f9d86",
        "name": "Onboarding Project"
      }
    ],
    "source": "",
    "tags": [],
    "traits": {},
    "updatedAt": "2026-02-10T20:03:04.384Z"
  }
}
```

### Create account

Add a customer account to Vitally, with your own id for it, its name, organization and traits.

**Inputs**

- Your ID (`external_id`, text, required): Your own unique id for the account, such as its id in your product or CRM.
- Name (`name`, text, required): The account's name.
- Organization (`organization_id`, text): The organization it belongs to, if any.
- Traits (`traits`, object): Values for the account's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "accountExecutiveId": "",
    "accountOwnerId": "",
    "churnedAt": "",
    "createdAt": "2025-10-23T22:55:16.923Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "account-101",
    "firstSeenTimestamp": "2025-10-24T09:12:00.000Z",
    "healthScore": 7.8,
    "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "keyRoles": [],
    "lastInboundMessageTimestamp": "2026-02-09T15:01:00.000Z",
    "lastOutboundMessageTimestamp": "2026-02-09T16:30:00.000Z",
    "lastSeenTimestamp": "2026-02-10T18:40:00.000Z",
    "mrr": 1250,
    "name": "Big Corp",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "segments": [
      {
        "id": "c0f1e2d3-a4b5-4c6d-9e8f-0a1b2c3d4e5f",
        "name": "Enterprise"
      }
    ],
    "traits": {
      "paymentMethod": "subscription",
      "vitally.custom.plan": "Growth"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### Create note

Add a note to an account or organization, such as a call summary, with its subject, author, category, tags and traits.

**Inputs**

- Account (`account_id`, text): The account the note is for. Pick one or give its Vitally id. Give an account or an organization.
- Organization (`organization_id`, text): The organization the note is for, if not an account. Pick one or give its Vitally id.
- Note (`note`, text, required): The note's text. Plain text, or HTML for formatting.
- Subject (`subject`, text): The note's subject or title.
- Date (`note_date`, date and time): The date and time the note is about. Now if left empty.
- Author (`author_id`, text): The teammate who wrote it.
- Category (`category_id`, text): The note's category.
- Tags (`tags`, list): Tags to put on it.
- Your ID (`external_id`, text): Your own id for it, such as its id in another tool. Leave empty if none.
- Traits (`traits`, object): Values for the note's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `note` (object): The note

**Example output**

```json
{
  "note": {
    "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "accountName": "Big Corp",
    "archivedAt": "",
    "authorId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "authorName": "Bertram Gilfoyle",
    "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
    "categoryName": "Meeting",
    "createdAt": "2025-11-08T23:21:55.172Z",
    "externalId": "",
    "id": "3d9b4e1b-8a7c-4f4d-8c6b-5e0a9f8d7b64",
    "note": "<p>Notes for an Onboarding Kickoff Call</p>",
    "noteDate": "2025-11-08T23:21:55.172Z",
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "organizationName": "Big Corp Holdings",
    "source": "",
    "subject": "Onboarding Kickoff",
    "tags": [
      "Onboarding guidance"
    ],
    "traits": {
      "vitally.custom.sentiment": "Healthy"
    },
    "updatedAt": "2026-01-29T01:14:00.725Z"
  }
}
```

### Create NPS response

Log an NPS answer a user gave elsewhere (such as in a survey tool): their score from 0 to 10 and what they wrote.

**Inputs**

- User (`vitally_user_id`, text, required): The user who answered: their Vitally id, from 'Find user' or an earlier step.
- Score (`score`, number, required): Their score, from 0 to 10. From 0 to 10.
- Feedback (`feedback`, text): What they wrote with it.
- Answered at (`responded_at`, date and time): When they answered. Now if left empty.
- Your ID (`external_id`, text): Your own id for the answer. Sending the same id again updates it instead of adding another.

**Outputs**

- `nps_response` (object): The NPS response

**Example output**

```json
{
  "nps_response": {
    "createdAt": "2025-10-23T23:05:35.067Z",
    "createdByService": "",
    "dismissedAt": "",
    "externalId": "",
    "feedback": "Love it!",
    "id": "e6aa4000-df2e-4d38-b493-140c48073610",
    "respondedAt": "2025-10-17T00:00:00.000Z",
    "score": 9,
    "surveyResponseId": "",
    "updatedAt": "2025-10-23T23:11:20.022Z",
    "userEmail": "jane@example.com",
    "userId": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
    "userName": "Jane McUser"
  }
}
```

### Create organization

Add an organization (a group of accounts, such as a parent company) to Vitally, with your own id for it, its name and traits.

**Inputs**

- Your ID (`external_id`, text, required): Your own unique id for the organization.
- Name (`name`, text, required): The organization's name.
- Traits (`traits`, object): Values for the organization's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `organization` (object): The organization

**Example output**

```json
{
  "organization": {
    "accountExecutiveId": "",
    "accountsCount": 1,
    "churnedAt": "",
    "createdAt": "2025-10-23T22:50:02.101Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "org-101",
    "firstPaidDate": "2025-11-01T00:00:00.000Z",
    "healthScore": 7.8,
    "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "keyRoles": [],
    "mrr": 1250,
    "name": "Big Corp Holdings",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationOwnerId": "",
    "segments": [],
    "traits": {
      "paymentMethod": "subscription"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### Create project

Start a project, such as an onboarding plan, for an account or organization from one of your project templates.

**Inputs**

- Template (`template_id`, text, required): The project template to start from.
- Account (`account_id`, text): The account the project is for. Pick one or give its Vitally id. Give an account or an organization.
- Organization (`organization_id`, text): The organization the project is for, if not an account. Pick one or give its Vitally id.
- Name (`name`, text): The project's name. The template's if left empty.
- Start by (`target_start_date`, date): When it should start. The template's setting if left empty.
- Finish by (`target_completion_date`, date): When it should be done. The template's setting if left empty.
- Owner (`owner_id`, text): The teammate who owns it.
- Category (`project_category_id`, text): The project's category. The template's if left empty.
- Traits (`traits`, object): Values for the project's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `project` (object): The project

**Example output**

```json
{
  "project": {
    "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "actualCompletionDate": "",
    "actualStartDate": "",
    "archivedAt": "",
    "createdAt": "2026-02-10T20:03:04.384Z",
    "durationInDays": 7,
    "id": "5f1d6a3d-0c9e-4b6f-8e8d-7a2c1b0f9d86",
    "name": "Onboarding @ Big Corp",
    "organizationId": "",
    "ownedByVitallyUserId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "projectCategoryId": "",
    "projectStatusId": "",
    "targetCompletionDate": "2026-04-01",
    "targetStartDate": "2026-03-01",
    "traits": {
      "vitally.custom.nextStep": "Give em a call!"
    }
  }
}
```

### Create task

Add a task for an account or organization, with a due date, assignee, category, tags and traits.

**Inputs**

- Title (`name`, text, required): What needs doing.
- Account (`account_id`, text): The account the task is for. Pick one or give its Vitally id. Give an account or an organization.
- Organization (`organization_id`, text): The organization the task is for, if not an account. Pick one or give its Vitally id.
- Description (`description`, text): More detail. Plain text, or HTML for formatting.
- Due (`due_date`, date): When it is due.
- Assigned to (`assigned_to_id`, text): The teammate to do it.
- Category (`category_id`, text): The task's category.
- Tags (`tags`, list): Tags to put on it.
- Your ID (`external_id`, text): Your own id for it, such as its id in another tool. Leave empty if none.
- Traits (`traits`, object): Values for the task's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "accountName": "Big Corp",
    "archivedAt": "",
    "assignedToEmail": "gilfoyle@example.com",
    "assignedToId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "assignedToName": "Bertram Gilfoyle",
    "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
    "categoryName": "Email",
    "completedAt": "",
    "completedById": "",
    "createdAt": "2026-02-10T00:00:00.000Z",
    "description": "<p>An email with a survey has been sent to the account regarding their experience. Follow up with them!</p>",
    "dueDate": "2026-02-24",
    "externalId": "",
    "id": "4e0c5f2c-9b8d-4a5e-9d7c-6f1b0a9e8c75",
    "name": "Gather Feedback",
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "organizationName": "Big Corp Holdings",
    "projects": [
      {
        "id": "5f1d6a3d-0c9e-4b6f-8e8d-7a2c1b0f9d86",
        "name": "Onboarding Project"
      }
    ],
    "source": "",
    "tags": [],
    "traits": {},
    "updatedAt": "2026-02-10T20:03:04.384Z"
  }
}
```

### Create user

Add a person to one or more accounts or organizations in Vitally, with your own id for them, name, email and traits.

**Inputs**

- Your ID (`external_id`, text, required): Your own unique id for the user, such as their id in your product.
- Accounts (`account_ids`, list): The accounts the user belongs to. Give at least one account or organization.
- Organizations (`organization_ids`, list): The organizations the user belongs to.
- Name (`name`, text): The user's full name.
- Email (`email`, text): The user's email address.
- Picture (`avatar`, text): The https:// address of their picture.
- Joined (`join_date`, date and time): When they started using your product.
- Conversation emails (`conversation_emails`, text): Whether the user gets your team's emails from Vitally. Leave empty to leave it as it is. One of: `subscribed`, `unsubscribed`.
- Traits (`traits`, object): Values for the user's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "accountIds": [
      "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31"
    ],
    "accounts": [
      {
        "externalId": "account-101",
        "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
        "name": "Big Corp"
      }
    ],
    "avatar": "",
    "createdAt": "2025-10-23T22:59:35.075Z",
    "deactivatedAt": "",
    "email": "jane@example.com",
    "externalId": "user-101",
    "firstKnown": "2025-07-24T22:56:07.716Z",
    "id": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
    "isPermanentlyBounced": false,
    "joinDate": "2025-07-24T22:56:07.716Z",
    "lastInboundMessageTimestamp": "",
    "lastOutboundMessageTimestamp": "",
    "lastSeenTimestamp": "",
    "name": "Jane McUser",
    "npsLastFeedback": "Love it!",
    "npsLastRespondedAt": "2025-10-17T00:00:00.000Z",
    "npsLastScore": 9,
    "organizationIds": [
      "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
    ],
    "organizations": [
      {
        "externalId": "org-101",
        "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
        "name": "Big Corp Holdings"
      }
    ],
    "segments": [],
    "traits": {
      "favoriteColor": "green"
    },
    "unsubscribedFromConversations": false,
    "updatedAt": "2026-04-09T06:18:47.559Z"
  }
}
```

### Delete account

Delete an account for good, with the notes, tasks, conversations and other data that belong only to it.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its Vitally id or your own id for it.

**Outputs**

- `account_id` (text): The account deleted
- `deleted` (true/false): True once Vitally deleted it

**Example output**

```json
{
  "account_id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
  "deleted": true
}
```

### Delete organization

Delete an organization for good, with the data that belongs only to it.

**Inputs**

- Organization (`organization_id`, text, required): The organization. Pick one, or give its Vitally id or your own id for it.

**Outputs**

- `deleted` (true/false): True once Vitally deleted it
- `organization_id` (text): The organization deleted

**Example output**

```json
{
  "deleted": true,
  "organization_id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
}
```

### Delete user

Delete a user now, or on a date you choose.

**Inputs**

- User (`vitally_user_id`, text, required): The user's Vitally id or your own id for them, from 'Find user' or an earlier step.
- Delete on (`delete_on`, date): Delete them on this day instead of now. Leave empty to delete now.

**Outputs**

- `delete_on` (text): The day they will be deleted, empty if deleted now
- `deleted` (true/false): True once Vitally took the request
- `user_id` (text): The user deleted

**Example output**

```json
{
  "delete_on": "",
  "deleted": true,
  "user_id": "a82fbf40-e270-4656-895d-c9b9fc2c9e62"
}
```

### Find user

Find a user by email address, by Vitally id or your own id, or every user at an email domain. Finding nobody is not an error.

**Inputs**

- Find by (`find_by`, text): What to look up. Email address unless you choose otherwise. One of: `email` (Email address), `id` (Vitally ID or your own ID), `email_domain` (Email domain (every user at it)). Default: `email`.
- Value (`value`, text, required): The email address, id or domain (such as example.com) to look for.

**Outputs**

- `count` (number): How many were found
- `found` (true/false): Whether any user was found
- `users` (list): The users found

**Example output**

```json
{
  "count": 1,
  "found": true,
  "users": [
    {
      "accountIds": [
        "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31"
      ],
      "accounts": [
        {
          "externalId": "account-101",
          "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
          "name": "Big Corp"
        }
      ],
      "avatar": "",
      "createdAt": "2025-10-23T22:59:35.075Z",
      "deactivatedAt": "",
      "email": "jane@example.com",
      "externalId": "user-101",
      "firstKnown": "2025-07-24T22:56:07.716Z",
      "id": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
      "isPermanentlyBounced": false,
      "joinDate": "2025-07-24T22:56:07.716Z",
      "lastInboundMessageTimestamp": "",
      "lastOutboundMessageTimestamp": "",
      "lastSeenTimestamp": "",
      "name": "Jane McUser",
      "npsLastFeedback": "Love it!",
      "npsLastRespondedAt": "2025-10-17T00:00:00.000Z",
      "npsLastScore": 9,
      "organizationIds": [
        "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
      ],
      "organizations": [
        {
          "externalId": "org-101",
          "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
          "name": "Big Corp Holdings"
        }
      ],
      "segments": [],
      "traits": {
        "favoriteColor": "green"
      },
      "unsubscribedFromConversations": false,
      "updatedAt": "2026-04-09T06:18:47.559Z"
    }
  ]
}
```

### Get account

Get one account by its Vitally id or your own id, with its health score, MRR, renewal date, NPS, owners, segments and traits.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its Vitally id or your own id for it.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "accountExecutiveId": "",
    "accountOwnerId": "",
    "churnedAt": "",
    "createdAt": "2025-10-23T22:55:16.923Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "account-101",
    "firstSeenTimestamp": "2025-10-24T09:12:00.000Z",
    "healthScore": 7.8,
    "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "keyRoles": [],
    "lastInboundMessageTimestamp": "2026-02-09T15:01:00.000Z",
    "lastOutboundMessageTimestamp": "2026-02-09T16:30:00.000Z",
    "lastSeenTimestamp": "2026-02-10T18:40:00.000Z",
    "mrr": 1250,
    "name": "Big Corp",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "segments": [
      {
        "id": "c0f1e2d3-a4b5-4c6d-9e8f-0a1b2c3d4e5f",
        "name": "Enterprise"
      }
    ],
    "traits": {
      "paymentMethod": "subscription",
      "vitally.custom.plan": "Growth"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### Get organization

Get one organization by its Vitally id or your own id.

**Inputs**

- Organization (`organization_id`, text, required): The organization. Pick one, or give its Vitally id or your own id for it.

**Outputs**

- `organization` (object): The organization

**Example output**

```json
{
  "organization": {
    "accountExecutiveId": "",
    "accountsCount": 1,
    "churnedAt": "",
    "createdAt": "2025-10-23T22:50:02.101Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "org-101",
    "firstPaidDate": "2025-11-01T00:00:00.000Z",
    "healthScore": 7.8,
    "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "keyRoles": [],
    "mrr": 1250,
    "name": "Big Corp Holdings",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationOwnerId": "",
    "segments": [],
    "traits": {
      "paymentMethod": "subscription"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### List accounts

List accounts with their health score, MRR, renewal and NPS, one page at a time; optionally only churned ones or one organization's.

**Inputs**

- Which accounts (`status`, text): Active, churned or both. Active unless you choose otherwise. With an organization, all of its accounts are listed. One of: `active` (Active accounts (default)), `churned` (Churned accounts), `activeOrChurned` (Active and churned accounts).
- Organization (`organization_id`, text): Only accounts of this organization. Leave empty for all.
- Order (`sort_by`, text): Which come first. Recently changed first unless you choose otherwise. One of: `updatedAt` (Recently changed first (default)), `createdAt` (Recently created first).
- How many (`limit`, number): How many to return, 1 to 100. Vitally returns 100 by default. From 1 to 100.
- Next page cursor (`cursor`, text): The next_cursor from an earlier page, to get the page after it. Keep the same order.

**Outputs**

- `accounts` (list): The accounts
- `count` (number): How many are on this page
- `next_cursor` (text): Pass as the cursor for the next page; empty on the last page

**Example output**

```json
{
  "accounts": [
    {
      "accountExecutiveId": "",
      "accountOwnerId": "",
      "churnedAt": "",
      "createdAt": "2025-10-23T22:55:16.923Z",
      "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
      "externalId": "account-101",
      "firstSeenTimestamp": "2025-10-24T09:12:00.000Z",
      "healthScore": 7.8,
      "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
      "keyRoles": [],
      "lastInboundMessageTimestamp": "2026-02-09T15:01:00.000Z",
      "lastOutboundMessageTimestamp": "2026-02-09T16:30:00.000Z",
      "lastSeenTimestamp": "2026-02-10T18:40:00.000Z",
      "mrr": 1250,
      "name": "Big Corp",
      "nextRenewalDate": "2026-12-01T00:00:00.000Z",
      "npsDetractorCount": 1,
      "npsPassiveCount": 2,
      "npsPromoterCount": 5,
      "npsScore": 50,
      "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
      "segments": [
        {
          "id": "c0f1e2d3-a4b5-4c6d-9e8f-0a1b2c3d4e5f",
          "name": "Enterprise"
        }
      ],
      "traits": {
        "paymentMethod": "subscription",
        "vitally.custom.plan": "Growth"
      },
      "trialEndDate": "",
      "updatedAt": "2026-02-10T20:03:04.384Z",
      "usersCount": 12
    }
  ],
  "count": 1,
  "next_cursor": "c29tZWJhc2U2NA=="
}
```

### List notes

List notes, all or one account's or organization's, newest changes first, one page at a time.

**Inputs**

- Account (`account_id`, text): Only notes of this account. Leave empty for all.
- Organization (`organization_id`, text): Only notes of this organization. Leave empty for all.
- Deleted (`archived`, text): Whether to list ones deleted in Vitally. Not deleted unless you choose otherwise. One of: `active` (Not deleted (default)), `deleted` (Deleted only), `all` (Both).
- Made by (`source`, text): Only notes made by this integration, such as hubspot or salesforce. Leave empty for all.
- Order (`sort_by`, text): Which come first. Recently changed first unless you choose otherwise. One of: `updatedAt` (Recently changed first (default)), `createdAt` (Recently created first).
- How many (`limit`, number): How many to return, 1 to 100. Vitally returns 100 by default. From 1 to 100.
- Next page cursor (`cursor`, text): The next_cursor from an earlier page, to get the page after it. Keep the same order.

**Outputs**

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

**Example output**

```json
{
  "count": 1,
  "next_cursor": "c29tZWJhc2U2NA==",
  "notes": [
    {
      "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
      "accountName": "Big Corp",
      "archivedAt": "",
      "authorId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
      "authorName": "Bertram Gilfoyle",
      "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
      "categoryName": "Meeting",
      "createdAt": "2025-11-08T23:21:55.172Z",
      "externalId": "",
      "id": "3d9b4e1b-8a7c-4f4d-8c6b-5e0a9f8d7b64",
      "note": "<p>Notes for an Onboarding Kickoff Call</p>",
      "noteDate": "2025-11-08T23:21:55.172Z",
      "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
      "organizationName": "Big Corp Holdings",
      "source": "",
      "subject": "Onboarding Kickoff",
      "tags": [
        "Onboarding guidance"
      ],
      "traits": {
        "vitally.custom.sentiment": "Healthy"
      },
      "updatedAt": "2026-01-29T01:14:00.725Z"
    }
  ]
}
```

### List NPS responses

List NPS answers with their scores and feedback, all or one account's or organization's, one page at a time.

**Inputs**

- Account (`account_id`, text): Only NPS responses of this account. Leave empty for all.
- Organization (`organization_id`, text): Only NPS responses of this organization. Leave empty for all.
- Order (`sort_by`, text): Which come first. Recently changed first unless you choose otherwise. One of: `updatedAt` (Recently changed first (default)), `createdAt` (Recently created first).
- How many (`limit`, number): How many to return, 1 to 100. Vitally returns 100 by default. From 1 to 100.
- Next page cursor (`cursor`, text): The next_cursor from an earlier page, to get the page after it. Keep the same order.

**Outputs**

- `count` (number): How many are on this page
- `next_cursor` (text): Pass as the cursor for the next page; empty on the last page
- `nps_responses` (list): The NPS responses

**Example output**

```json
{
  "count": 1,
  "next_cursor": "c29tZWJhc2U2NA==",
  "nps_responses": [
    {
      "createdAt": "2025-10-23T23:05:35.067Z",
      "createdByService": "",
      "dismissedAt": "",
      "externalId": "",
      "feedback": "Love it!",
      "id": "e6aa4000-df2e-4d38-b493-140c48073610",
      "respondedAt": "2025-10-17T00:00:00.000Z",
      "score": 9,
      "surveyResponseId": "",
      "updatedAt": "2025-10-23T23:11:20.022Z",
      "userEmail": "jane@example.com",
      "userId": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
      "userName": "Jane McUser"
    }
  ]
}
```

### List project templates

List your project templates (such as onboarding plans) with their ids, to start a project from one.

**Inputs**

- Category (`project_category_id`, text): Only templates in this project category. Leave empty for all.

**Outputs**

- `count` (number): How many there are
- `project_templates` (list): The project templates

**Example output**

```json
{
  "count": 1,
  "project_templates": [
    {
      "createdAt": "2022-02-02T22:22:22.222Z",
      "description": "",
      "id": "6a2e7b4e-1d0f-4c7a-9f9e-8b3d2c1a0e97",
      "name": "Onboarding - Enterprise",
      "projectCategoryId": "1",
      "projectName": "Onboarding",
      "updatedAt": "2022-02-02T22:22:22.222Z"
    }
  ]
}
```

### List tasks

List tasks, all or one account's or organization's, with their due dates, assignees and whether they are done, one page at a time.

**Inputs**

- Account (`account_id`, text): Only tasks of this account. Leave empty for all.
- Organization (`organization_id`, text): Only tasks of this organization. Leave empty for all.
- Deleted (`archived`, text): Whether to list ones deleted in Vitally. Not deleted unless you choose otherwise. One of: `active` (Not deleted (default)), `deleted` (Deleted only), `all` (Both).
- Order (`sort_by`, text): Which come first. Recently changed first unless you choose otherwise. One of: `updatedAt` (Recently changed first (default)), `createdAt` (Recently created first).
- How many (`limit`, number): How many to return, 1 to 100. Vitally returns 100 by default. From 1 to 100.
- Next page cursor (`cursor`, text): The next_cursor from an earlier page, to get the page after it. Keep the same order.

**Outputs**

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

**Example output**

```json
{
  "count": 1,
  "next_cursor": "c29tZWJhc2U2NA==",
  "tasks": [
    {
      "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
      "accountName": "Big Corp",
      "archivedAt": "",
      "assignedToEmail": "gilfoyle@example.com",
      "assignedToId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
      "assignedToName": "Bertram Gilfoyle",
      "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
      "categoryName": "Email",
      "completedAt": "",
      "completedById": "",
      "createdAt": "2026-02-10T00:00:00.000Z",
      "description": "<p>An email with a survey has been sent to the account regarding their experience. Follow up with them!</p>",
      "dueDate": "2026-02-24",
      "externalId": "",
      "id": "4e0c5f2c-9b8d-4a5e-9d7c-6f1b0a9e8c75",
      "name": "Gather Feedback",
      "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
      "organizationName": "Big Corp Holdings",
      "projects": [
        {
          "id": "5f1d6a3d-0c9e-4b6f-8e8d-7a2c1b0f9d86",
          "name": "Onboarding Project"
        }
      ],
      "source": "",
      "tags": [],
      "traits": {},
      "updatedAt": "2026-02-10T20:03:04.384Z"
    }
  ]
}
```

### List team members

List the teammates in your Vitally workspace with their ids, emails and roles, or find one by email.

**Inputs**

- Email (`email`, text): Only the teammate with this email address. Leave empty for everyone.

**Outputs**

- `count` (number): How many there are
- `team_members` (list): The teammates

**Example output**

```json
{
  "count": 1,
  "team_members": [
    {
      "email": "richard@example.com",
      "id": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
      "licenseStatus": "active",
      "name": "Richard Hendricks",
      "role": "admin"
    }
  ]
}
```

### List users

List the people at your customers, all or one account's or organization's, one page at a time.

**Inputs**

- Account (`account_id`, text): Only users of this account. Leave empty for all.
- Organization (`organization_id`, text): Only users of this organization. Leave empty for all.
- Order (`sort_by`, text): Which come first. Recently changed first unless you choose otherwise. One of: `updatedAt` (Recently changed first (default)), `createdAt` (Recently created first).
- How many (`limit`, number): How many to return, 1 to 100. Vitally returns 100 by default. From 1 to 100.
- Next page cursor (`cursor`, text): The next_cursor from an earlier page, to get the page after it. Keep the same order.

**Outputs**

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

**Example output**

```json
{
  "count": 1,
  "next_cursor": "c29tZWJhc2U2NA==",
  "users": [
    {
      "accountIds": [
        "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31"
      ],
      "accounts": [
        {
          "externalId": "account-101",
          "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
          "name": "Big Corp"
        }
      ],
      "avatar": "",
      "createdAt": "2025-10-23T22:59:35.075Z",
      "deactivatedAt": "",
      "email": "jane@example.com",
      "externalId": "user-101",
      "firstKnown": "2025-07-24T22:56:07.716Z",
      "id": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
      "isPermanentlyBounced": false,
      "joinDate": "2025-07-24T22:56:07.716Z",
      "lastInboundMessageTimestamp": "",
      "lastOutboundMessageTimestamp": "",
      "lastSeenTimestamp": "",
      "name": "Jane McUser",
      "npsLastFeedback": "Love it!",
      "npsLastRespondedAt": "2025-10-17T00:00:00.000Z",
      "npsLastScore": 9,
      "organizationIds": [
        "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
      ],
      "organizations": [
        {
          "externalId": "org-101",
          "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
          "name": "Big Corp Holdings"
        }
      ],
      "segments": [],
      "traits": {
        "favoriteColor": "green"
      },
      "unsubscribedFromConversations": false,
      "updatedAt": "2026-04-09T06:18:47.559Z"
    }
  ]
}
```

### Update account

Rename an account, move it to another organization, or set its traits. Only what you fill in changes.

**Inputs**

- Account (`account_id`, text, required): The account. Pick one, or give its Vitally id or your own id for it.
- Name (`name`, text): A new name. Leave empty to keep it.
- Organization (`organization_id`, text): Move it to this organization. Leave empty to keep it.
- Remove from its organization (`remove_from_organization`, true/false): Take the account out of the organization it is in.
- Traits (`traits`, object): Values for the account's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `account` (object): The account

**Example output**

```json
{
  "account": {
    "accountExecutiveId": "",
    "accountOwnerId": "",
    "churnedAt": "",
    "createdAt": "2025-10-23T22:55:16.923Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "account-101",
    "firstSeenTimestamp": "2025-10-24T09:12:00.000Z",
    "healthScore": 7.8,
    "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "keyRoles": [],
    "lastInboundMessageTimestamp": "2026-02-09T15:01:00.000Z",
    "lastOutboundMessageTimestamp": "2026-02-09T16:30:00.000Z",
    "lastSeenTimestamp": "2026-02-10T18:40:00.000Z",
    "mrr": 1250,
    "name": "Big Corp",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "segments": [
      {
        "id": "c0f1e2d3-a4b5-4c6d-9e8f-0a1b2c3d4e5f",
        "name": "Enterprise"
      }
    ],
    "traits": {
      "paymentMethod": "subscription",
      "vitally.custom.plan": "Growth"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### Update organization

Rename an organization or set its traits. Only what you fill in changes.

**Inputs**

- Organization (`organization_id`, text, required): The organization. Pick one, or give its Vitally id or your own id for it.
- Name (`name`, text): A new name. Leave empty to keep it.
- Traits (`traits`, object): Values for the organization's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `organization` (object): The organization

**Example output**

```json
{
  "organization": {
    "accountExecutiveId": "",
    "accountsCount": 1,
    "churnedAt": "",
    "createdAt": "2025-10-23T22:50:02.101Z",
    "csmId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "externalId": "org-101",
    "firstPaidDate": "2025-11-01T00:00:00.000Z",
    "healthScore": 7.8,
    "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "keyRoles": [],
    "mrr": 1250,
    "name": "Big Corp Holdings",
    "nextRenewalDate": "2026-12-01T00:00:00.000Z",
    "npsDetractorCount": 1,
    "npsPassiveCount": 2,
    "npsPromoterCount": 5,
    "npsScore": 50,
    "organizationOwnerId": "",
    "segments": [],
    "traits": {
      "paymentMethod": "subscription"
    },
    "trialEndDate": "",
    "updatedAt": "2026-02-10T20:03:04.384Z",
    "usersCount": 12
  }
}
```

### Update task

Change a task's title, description, due date, assignee, category, tags or traits. Only what you fill in changes; its tags are kept unless you give new ones.

**Inputs**

- Task (`task_id`, text, required): The task's Vitally id, from 'Create task', 'List tasks' or a trigger.
- Title (`name`, text): A new title. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.
- Due (`due_date`, date): A new due date.
- Assigned to (`assigned_to_id`, text): Assign it to this teammate.
- Category (`category_id`, text): A new category.
- Tags (`tags`, list): Replace its tags with these. Leave empty to keep them.
- Traits (`traits`, object): Values for the task's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "accountId": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
    "accountName": "Big Corp",
    "archivedAt": "",
    "assignedToEmail": "gilfoyle@example.com",
    "assignedToId": "2c8a3d0a-7f6b-4e3c-9b5a-4d9f8e7c6a53",
    "assignedToName": "Bertram Gilfoyle",
    "categoryId": "7b3f8c5f-2e1a-4d8b-8a0f-9c4e3d2b1fa8",
    "categoryName": "Email",
    "completedAt": "",
    "completedById": "",
    "createdAt": "2026-02-10T00:00:00.000Z",
    "description": "<p>An email with a survey has been sent to the account regarding their experience. Follow up with them!</p>",
    "dueDate": "2026-02-24",
    "externalId": "",
    "id": "4e0c5f2c-9b8d-4a5e-9d7c-6f1b0a9e8c75",
    "name": "Gather Feedback",
    "organizationId": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
    "organizationName": "Big Corp Holdings",
    "projects": [
      {
        "id": "5f1d6a3d-0c9e-4b6f-8e8d-7a2c1b0f9d86",
        "name": "Onboarding Project"
      }
    ],
    "source": "",
    "tags": [],
    "traits": {},
    "updatedAt": "2026-02-10T20:03:04.384Z"
  }
}
```

### Update user

Change a user's name, email, picture, conversation emails or traits, or add them to more accounts. Only what you fill in changes.

**Inputs**

- User (`vitally_user_id`, text, required): The user's Vitally id or your own id for them, from 'Find user' or an earlier step.
- Accounts (`account_ids`, list): Add the user to these accounts. Vitally can't take a user out of an account this way.
- Organizations (`organization_ids`, list): Add the user to these organizations.
- Name (`name`, text): The user's full name.
- Email (`email`, text): The user's email address.
- Picture (`avatar`, text): The https:// address of their picture.
- Joined (`join_date`, date and time): When they started using your product.
- Conversation emails (`conversation_emails`, text): Whether the user gets your team's emails from Vitally. Leave empty to leave it as it is. One of: `subscribed`, `unsubscribed`.
- Traits (`traits`, object): Values for the user's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
- Other traits (`other_traits`, object): Traits by key, for one not offered in Traits, such as plan. A key Vitally doesn't have yet becomes a new trait: true or false makes a yes/no trait, a plain number a number trait.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "accountIds": [
      "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31"
    ],
    "accounts": [
      {
        "externalId": "account-101",
        "id": "0a6e1b8e-5d4f-4c1a-9f3e-2b7d6c5a4e31",
        "name": "Big Corp"
      }
    ],
    "avatar": "",
    "createdAt": "2025-10-23T22:59:35.075Z",
    "deactivatedAt": "",
    "email": "jane@example.com",
    "externalId": "user-101",
    "firstKnown": "2025-07-24T22:56:07.716Z",
    "id": "a82fbf40-e270-4656-895d-c9b9fc2c9e62",
    "isPermanentlyBounced": false,
    "joinDate": "2025-07-24T22:56:07.716Z",
    "lastInboundMessageTimestamp": "",
    "lastOutboundMessageTimestamp": "",
    "lastSeenTimestamp": "",
    "name": "Jane McUser",
    "npsLastFeedback": "Love it!",
    "npsLastRespondedAt": "2025-10-17T00:00:00.000Z",
    "npsLastScore": 9,
    "organizationIds": [
      "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
    ],
    "organizations": [
      {
        "externalId": "org-101",
        "id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42",
        "name": "Big Corp Holdings"
      }
    ],
    "segments": [],
    "traits": {
      "favoriteColor": "green"
    },
    "unsubscribedFromConversations": false,
    "updatedAt": "2026-04-09T06:18:47.559Z"
  }
}
```
