Vitally

App · 25 actions

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.

Actions

ActionWhat it does
Complete taskMark a task as done, by a teammate if you like.
Create accountAdd a customer account to Vitally, with your own id for it, its name, organization and traits.
Create noteAdd a note to an account or organization, such as a call summary, with its subject, author, category, tags and traits.
Create NPS responseLog an NPS answer a user gave elsewhere (such as in a survey tool): their score from 0 to 10 and what they wrote.
Create organizationAdd an organization (a group of accounts, such as a parent company) to Vitally, with your own id for it, its name and traits.
Create projectStart a project, such as an onboarding plan, for an account or organization from one of your project templates.
Create taskAdd a task for an account or organization, with a due date, assignee, category, tags and traits.
Create userAdd a person to one or more accounts or organizations in Vitally, with your own id for them, name, email and traits.
Delete accountDelete an account for good, with the notes, tasks, conversations and other data that belong only to it.
Delete organizationDelete an organization for good, with the data that belongs only to it.
Delete userDelete a user now, or on a date you choose.
Find userFind a user by email address, by Vitally id or your own id, or every user at an email domain.
Get accountGet one account by its Vitally id or your own id, with its health score, MRR, renewal date, NPS, owners, segments and traits.
Get organizationGet one organization by its Vitally id or your own id.
List accountsList accounts with their health score, MRR, renewal and NPS, one page at a time; optionally only churned ones or one organization's.
List notesList notes, all or one account's or organization's, newest changes first, one page at a time.
List NPS responsesList NPS answers with their scores and feedback, all or one account's or organization's, one page at a time.
List project templatesList your project templates (such as onboarding plans) with their ids, to start a project from one.
List tasksList tasks, all or one account's or organization's, with their due dates, assignees and whether they are done, one page at a time.
List team membersList the teammates in your Vitally workspace with their ids, emails and roles, or find one by email.
List usersList the people at your customers, all or one account's or organization's, one page at a time.
Update accountRename an account, move it to another organization, or set its traits.
Update organizationRename an organization or set its traits.
Update taskChange a task's title, description, due date, assignee, category, tags or traits.
Update userChange a user's name, email, picture, conversation emails or traits, or add them to more accounts.

Complete task

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

Inputs

Tasktask_idtextRequired
The task's Vitally id, from 'Create task', 'List tasks' or a trigger.
Completed bycompleted_by_idtext
The teammate who did it.
Completed atcompleted_atdate and time
When it was done. Now if left empty.

Outputs

already_completedtrue/false
True when the task was already done, so nothing changed
taskobject
The task
Example output
{
  "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 IDexternal_idtextRequired
Your own unique id for the account, such as its id in your product or CRM.
NamenametextRequired
The account's name.
Organizationorganization_idtext
The organization it belongs to, if any.
Traitstraitsobject
Values for the account's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

accountobject
The account
Example output
{
  "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

Accountaccount_idtext
The account the note is for. Pick one or give its Vitally id. Give an account or an organization.
Organizationorganization_idtext
The organization the note is for, if not an account. Pick one or give its Vitally id.
NotenotetextRequired
The note's text. Plain text, or HTML for formatting.
Subjectsubjecttext
The note's subject or title.
Datenote_datedate and time
The date and time the note is about. Now if left empty.
Authorauthor_idtext
The teammate who wrote it.
Categorycategory_idtext
The note's category.
Tagstagslist
Tags to put on it.
Your IDexternal_idtext
Your own id for it, such as its id in another tool. Leave empty if none.
Traitstraitsobject
Values for the note's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

noteobject
The note
Example output
{
  "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

Uservitally_user_idtextRequired
The user who answered: their Vitally id, from 'Find user' or an earlier step.
ScorescorenumberRequired
Their score, from 0 to 10.From 0 to 10.
Feedbackfeedbacktext
What they wrote with it.
Answered atresponded_atdate and time
When they answered. Now if left empty.
Your IDexternal_idtext
Your own id for the answer. Sending the same id again updates it instead of adding another.

Outputs

nps_responseobject
The NPS response
Example output
{
  "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 IDexternal_idtextRequired
Your own unique id for the organization.
NamenametextRequired
The organization's name.
Traitstraitsobject
Values for the organization's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

organizationobject
The organization
Example output
{
  "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

Templatetemplate_idtextRequired
The project template to start from.
Accountaccount_idtext
The account the project is for. Pick one or give its Vitally id. Give an account or an organization.
Organizationorganization_idtext
The organization the project is for, if not an account. Pick one or give its Vitally id.
Namenametext
The project's name. The template's if left empty.
Start bytarget_start_datedate
When it should start. The template's setting if left empty.
Finish bytarget_completion_datedate
When it should be done. The template's setting if left empty.
Ownerowner_idtext
The teammate who owns it.
Categoryproject_category_idtext
The project's category. The template's if left empty.
Traitstraitsobject
Values for the project's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

projectobject
The project
Example output
{
  "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

TitlenametextRequired
What needs doing.
Accountaccount_idtext
The account the task is for. Pick one or give its Vitally id. Give an account or an organization.
Organizationorganization_idtext
The organization the task is for, if not an account. Pick one or give its Vitally id.
Descriptiondescriptiontext
More detail. Plain text, or HTML for formatting.
Duedue_datedate
When it is due.
Assigned toassigned_to_idtext
The teammate to do it.
Categorycategory_idtext
The task's category.
Tagstagslist
Tags to put on it.
Your IDexternal_idtext
Your own id for it, such as its id in another tool. Leave empty if none.
Traitstraitsobject
Values for the task's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

taskobject
The task
Example output
{
  "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 IDexternal_idtextRequired
Your own unique id for the user, such as their id in your product.
Accountsaccount_idslist
The accounts the user belongs to. Give at least one account or organization.
Organizationsorganization_idslist
The organizations the user belongs to.
Namenametext
The user's full name.
Emailemailtext
The user's email address.
Pictureavatartext
The https:// address of their picture.
Joinedjoin_datedate and time
When they started using your product.
Conversation emailsconversation_emailstext
Whether the user gets your team's emails from Vitally. Leave empty to leave it as it is.One of: subscribed, unsubscribed.
Traitstraitsobject
Values for the user's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

userobject
The user
Example output
{
  "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

Accountaccount_idtextRequired
The account. Pick one, or give its Vitally id or your own id for it.

Outputs

account_idtext
The account deleted
deletedtrue/false
True once Vitally deleted it
Example output
{
  "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

Organizationorganization_idtextRequired
The organization. Pick one, or give its Vitally id or your own id for it.

Outputs

deletedtrue/false
True once Vitally deleted it
organization_idtext
The organization deleted
Example output
{
  "deleted": true,
  "organization_id": "1b7f2c9f-6e5a-4d2b-8a4f-3c8e7d6b5f42"
}

Delete user

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

Inputs

Uservitally_user_idtextRequired
The user's Vitally id or your own id for them, from 'Find user' or an earlier step.
Delete ondelete_ondate
Delete them on this day instead of now. Leave empty to delete now.

Outputs

delete_ontext
The day they will be deleted, empty if deleted now
deletedtrue/false
True once Vitally took the request
user_idtext
The user deleted
Example output
{
  "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 byfind_bytext
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.
ValuevaluetextRequired
The email address, id or domain (such as example.com) to look for.

Outputs

countnumber
How many were found
foundtrue/false
Whether any user was found
userslist
The users found
Example output
{
  "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

Accountaccount_idtextRequired
The account. Pick one, or give its Vitally id or your own id for it.

Outputs

accountobject
The account
Example output
{
  "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

Organizationorganization_idtextRequired
The organization. Pick one, or give its Vitally id or your own id for it.

Outputs

organizationobject
The organization
Example output
{
  "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 accountsstatustext
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).
Organizationorganization_idtext
Only accounts of this organization. Leave empty for all.
Ordersort_bytext
Which come first. Recently changed first unless you choose otherwise.One of: updatedAt (Recently changed first (default)), createdAt (Recently created first).
How manylimitnumber
How many to return, 1 to 100. Vitally returns 100 by default.From 1 to 100.
Next page cursorcursortext
The next_cursor from an earlier page, to get the page after it. Keep the same order.

Outputs

accountslist
The accounts
countnumber
How many are on this page
next_cursortext
Pass as the cursor for the next page; empty on the last page
Example output
{
  "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

Accountaccount_idtext
Only notes of this account. Leave empty for all.
Organizationorganization_idtext
Only notes of this organization. Leave empty for all.
Deletedarchivedtext
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 bysourcetext
Only notes made by this integration, such as hubspot or salesforce. Leave empty for all.
Ordersort_bytext
Which come first. Recently changed first unless you choose otherwise.One of: updatedAt (Recently changed first (default)), createdAt (Recently created first).
How manylimitnumber
How many to return, 1 to 100. Vitally returns 100 by default.From 1 to 100.
Next page cursorcursortext
The next_cursor from an earlier page, to get the page after it. Keep the same order.

Outputs

countnumber
How many are on this page
next_cursortext
Pass as the cursor for the next page; empty on the last page
noteslist
The notes
Example output
{
  "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

Accountaccount_idtext
Only NPS responses of this account. Leave empty for all.
Organizationorganization_idtext
Only NPS responses of this organization. Leave empty for all.
Ordersort_bytext
Which come first. Recently changed first unless you choose otherwise.One of: updatedAt (Recently changed first (default)), createdAt (Recently created first).
How manylimitnumber
How many to return, 1 to 100. Vitally returns 100 by default.From 1 to 100.
Next page cursorcursortext
The next_cursor from an earlier page, to get the page after it. Keep the same order.

Outputs

countnumber
How many are on this page
next_cursortext
Pass as the cursor for the next page; empty on the last page
nps_responseslist
The NPS responses
Example output
{
  "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

Categoryproject_category_idtext
Only templates in this project category. Leave empty for all.

Outputs

countnumber
How many there are
project_templateslist
The project templates
Example output
{
  "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

Accountaccount_idtext
Only tasks of this account. Leave empty for all.
Organizationorganization_idtext
Only tasks of this organization. Leave empty for all.
Deletedarchivedtext
Whether to list ones deleted in Vitally. Not deleted unless you choose otherwise.One of: active (Not deleted (default)), deleted (Deleted only), all (Both).
Ordersort_bytext
Which come first. Recently changed first unless you choose otherwise.One of: updatedAt (Recently changed first (default)), createdAt (Recently created first).
How manylimitnumber
How many to return, 1 to 100. Vitally returns 100 by default.From 1 to 100.
Next page cursorcursortext
The next_cursor from an earlier page, to get the page after it. Keep the same order.

Outputs

countnumber
How many are on this page
next_cursortext
Pass as the cursor for the next page; empty on the last page
taskslist
The tasks
Example output
{
  "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

Emailemailtext
Only the teammate with this email address. Leave empty for everyone.

Outputs

countnumber
How many there are
team_memberslist
The teammates
Example output
{
  "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

Accountaccount_idtext
Only users of this account. Leave empty for all.
Organizationorganization_idtext
Only users of this organization. Leave empty for all.
Ordersort_bytext
Which come first. Recently changed first unless you choose otherwise.One of: updatedAt (Recently changed first (default)), createdAt (Recently created first).
How manylimitnumber
How many to return, 1 to 100. Vitally returns 100 by default.From 1 to 100.
Next page cursorcursortext
The next_cursor from an earlier page, to get the page after it. Keep the same order.

Outputs

countnumber
How many are on this page
next_cursortext
Pass as the cursor for the next page; empty on the last page
userslist
The users
Example output
{
  "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

Accountaccount_idtextRequired
The account. Pick one, or give its Vitally id or your own id for it.
Namenametext
A new name. Leave empty to keep it.
Organizationorganization_idtext
Move it to this organization. Leave empty to keep it.
Remove from its organizationremove_from_organizationtrue/false
Take the account out of the organization it is in.
Traitstraitsobject
Values for the account's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

accountobject
The account
Example output
{
  "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

Organizationorganization_idtextRequired
The organization. Pick one, or give its Vitally id or your own id for it.
Namenametext
A new name. Leave empty to keep it.
Traitstraitsobject
Values for the organization's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

organizationobject
The organization
Example output
{
  "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

Tasktask_idtextRequired
The task's Vitally id, from 'Create task', 'List tasks' or a trigger.
Titlenametext
A new title. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Duedue_datedate
A new due date.
Assigned toassigned_to_idtext
Assign it to this teammate.
Categorycategory_idtext
A new category.
Tagstagslist
Replace its tags with these. Leave empty to keep them.
Traitstraitsobject
Values for the task's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

taskobject
The task
Example output
{
  "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

Uservitally_user_idtextRequired
The user's Vitally id or your own id for them, from 'Find user' or an earlier step.
Accountsaccount_idslist
Add the user to these accounts. Vitally can't take a user out of an account this way.
Organizationsorganization_idslist
Add the user to these organizations.
Namenametext
The user's full name.
Emailemailtext
The user's email address.
Pictureavatartext
The https:// address of their picture.
Joinedjoin_datedate and time
When they started using your product.
Conversation emailsconversation_emailstext
Whether the user gets your team's emails from Vitally. Leave empty to leave it as it is.One of: subscribed, unsubscribed.
Traitstraitsobject
Values for the user's traits (custom fields), one box per trait in Vitally. Boxes left empty are not changed.
Other traitsother_traitsobject
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

userobject
The user
Example output
{
  "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"
  }
}

On this page