Accounts
Accounts are the companies your feedback comes from, and every contact belongs to one. List, create, update and delete accounts, read one with its contacts, and add, change or delete the contacts under an account. Deleting an account also deletes its contacts. See Contacts.
List customer accounts
Returns customer/company accounts in the workspace. Accounts represent organizations that interact with the product. Called with no parameters it returns every account. Any parameter (search, a filter, a sort, page or limit) returns one filtered, sorted page instead, 50 rows unless limit says otherwise. search matches the account name. To find a person, use list-contacts, which also matches their account's name. Returns: id, name, accountType, website, lifecycleState, isStrategic, estimatedArr, tags, contactCount, createdAt.
path Parameters
workspaceIdWorkspace UUID
query Parameters
pagePage number (1-indexed, default 1)
limitItems per page (default 50)
sortByField to sort by
sortOrderSort direction (default desc)
searchMatch the account name, case-insensitively, as one substring ("acme" finds Acme Corp).
organizationIdOrganization UUID (defaults to user's org)
accountTypeFilter by account type (single value or array)
lifecycleStateFilter by lifecycle stage (single value or array)
tagsFilter by tag names (single value or comma-separated array)
List customer accounts › Responses
List of accounts
Create a customer account
Add a company or organization your feedback comes from, to track its people, interactions and feature requests. Accounts are not deduplicated by name, so look first: search list-accounts for the name and use the account you find rather than adding a second one. The response's id is the accountId that create-contact takes to file a person under this account. Tags are not set here: add them afterwards with add-tag (entity: "account", entityId this account's id).
path Parameters
workspaceIdWorkspace UUID
Create a customer account › Request Body
nameThe company or organization's name, e.g. "Acme Corp". 1 to 100 characters.
accountTypeWhat the company is to you: customer, partner, internal (your own company) or other.
The company's website, as a full URL such as "https://www.example.com".
notesFree-text notes about the account, up to 2000 characters.
sourceTypeHow the record came to exist: manual, feedback_stream, research_interview or crm_import. Set when importing records; leave it out when adding one by hand.
sourceIdThe UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.
externalSourceWhich CRM this record was imported from.
externalIdThe CRM's own id for this record — people/c123…, 701.
externalSourceUrlDeep link back to the record in the CRM.
isStrategicWhether this is a strategic account: one that matters especially to you, shown with a star.
estimatedArrThe account's estimated annual recurring revenue: a non-negative number with no currency symbol, e.g. 120000.
lifecycleStateWhere the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.
Create a customer account › Responses
Created account
Get an account by ID
Retrieve a single customer account with its contacts.
path Parameters
workspaceIdWorkspace UUID
idAccount UUID
Get an account by ID › Responses
Account details
Update a customer account
Change an account's name, type, website, notes, lifecycle stage, strategic flag or estimated annual recurring revenue. Only the fields you send change. notes replaces the whole text, so read the account with get-account first and send the combined notes. website: "" clears the website. Tags are not fields of the account: add one with add-tag and remove one with delete-tag (entity: "account").
path Parameters
workspaceIdWorkspace UUID
idThe account's UUID: its id from list-accounts or get-account.
Update a customer account › Request Body
nameThe company or organization's name, e.g. "Acme Corp". 1 to 100 characters.
accountTypeWhat the company is to you: customer, partner, internal (your own company) or other.
The company's website, as a full URL such as "https://www.example.com". Send "" to clear it.
notesFree-text notes about the account, up to 2000 characters. Replaces the whole text: read the current notes with get-account first and send the combined text.
isStrategicWhether this is a strategic account: one that matters especially to you, shown with a star.
The account's estimated annual recurring revenue: a non-negative number with no currency symbol, e.g. 120000.
lifecycleStateWhere the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.
externalSourceWhich CRM this record was imported from.
externalIdThe CRM's own id for this record — people/c123…, 701.
externalSourceUrlDeep link back to the record in the CRM.
Update a customer account › Responses
Updated account
List contacts for an account
Returns every contact (person) of one customer account, primary contact first, then by name. It takes no search or paging: to find a person by name, email or company, use list-contacts. Returns: id, name, email, title, phone, isPrimary, accountId, accountName, createdAt.
path Parameters
workspaceIdWorkspace UUID
accountIdAccount UUID
List contacts for an account › Responses
List of contacts
Create a contact for an account
Add a person as a contact under a customer account.
path Parameters
workspaceIdWorkspace UUID
accountIdAccount UUID
Create a contact for an account › Request Body
nameThe person's full name, e.g. "Jane Doe". 1 to 100 characters.
The person's email address, e.g. "jane.doe@example.com". It identifies the person: when a contact already has this address (in any letter case), that contact is returned instead and nothing is created. Leave it out when you don't know it.
titleThe person's job title or role, e.g. "Head of Operations". Up to 100 characters.
phoneThe person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.
accountIdThe UUID of the account (company) the person belongs to: an account's id from list-accounts, or from create-account for a company you just added. Leave it out only when nobody knows the company: the contact is then filed under the "Unknown" account.
isPrimaryWhether this person is the account's primary contact: the main person there, listed first and shown with a star. Marking one contact primary does not unmark another.
sourceTypeHow the record came to exist: manual, feedback_stream, research_interview or crm_import. Set when importing records; leave it out when adding one by hand.
sourceIdThe UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.
externalSourceWhich CRM this record was imported from.
externalIdThe CRM's own id for this record — people/c123…, 701.
externalSourceUrlDeep link back to the record in the CRM.
Create a contact for an account › Responses
Contact created
Update an account contact
Modify contact details (name, email, title).
path Parameters
workspaceIdWorkspace UUID
accountIdAccount UUID
idContact UUID
Update an account contact › Request Body
nameThe person's full name, e.g. "Jane Doe". 1 to 100 characters.
The person's email address, e.g. "jane.doe@example.com"; "" clears it. A new address is not checked against other contacts here: search list-contacts for it first, because another contact may already have it.
titleThe person's job title or role, e.g. "Head of Operations". Up to 100 characters.
phoneThe person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.
accountIdMoves the contact to another account: that account's id, from list-accounts or create-account. Every contact belongs to one account, so it cannot be cleared.
isPrimaryWhether this person is the account's primary contact: the main person there, listed first and shown with a star. Marking one contact primary does not unmark another.
externalSourceWhich CRM this record was imported from.
externalIdThe CRM's own id for this record — people/c123…, 701.
externalSourceUrlDeep link back to the record in the CRM.
releaseUpdatesOptOuttrue stops the release update emails to this person; false sends them again.
Update an account contact › Responses
Contact updated