Contacts
Contacts are the people your feedback comes from, and each belongs to one account. List and search contacts across accounts, create and update them, move one to another account, delete one or many at a time, and match a list of email addresses to existing contacts. Creating a contact with an email address you already have returns the existing contact instead of adding a duplicate. See Contacts.
List contacts in a workspace
Returns the contacts (people) in the workspace, across accounts. The way to find a person by what you know: search matches the contact's name, email and account (company) name word by word, so "jane acme" or "Doe Jane" finds Jane Doe at Acme in one call. Always paginated; also filters by account and sorts, incl. the derived lastContactedAt. Returns: id, name, email, title, phone, accountId, accountName, lastContactedAt, createdAt. A row's id is the requestingContactId that records this person's interest in a feature request.
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)
searchFind people by what you know about them. Matches the contact's name, email and account (company) name, case-insensitively, word by word: EVERY word must appear in one of the three, in any order. "jane acme", "Doe Jane" and "jane@acme" all find Jane Doe at Acme. Up to 8 words.
accountIdsComma-separated account UUIDs to filter by
List contacts in a workspace › Responses
List of contacts
Create a contact
Add a person as a contact. Find-or-create on the email address: when a contact with that address already exists in the organization the existing one is returned unchanged, matched case-insensitively, so this endpoint cannot file a duplicate. The response then carries matchedExisting: true: nothing was created and the details you sent were not applied (change them with update-contact). A contact with no email always creates, so look for the person with list-contacts first: it matches name, email and company. accountId is optional: when omitted the contact is filed under the organization's "Unknown" account (created on demand) and can be moved to a real account later. The response's id is the requestingContactId that create-feature-request and add-feature-request-interest take.
path Parameters
workspaceIdWorkspace UUID
Create a 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". 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 › Responses
The created contact, or the existing one when the address already had one (matchedExisting: true)
Match emails to existing contacts
Resolve a list of external email addresses (e.g. calendar attendees) to existing contacts. Attendees on the acting user's own email domain are reported separately as internal and never matched; the rest are matched by exact, case-insensitive email. Duplicates, blanks and malformed addresses are dropped. A read, expressed as a POST because the input is a list.
path Parameters
workspaceIdWorkspace UUID
Match emails to existing contacts › Request Body
emailsAttendee email addresses to match against existing contacts
Match emails to existing contacts › Responses
Matched contacts, unmatched emails and internal (filtered) emails
Get a contact by ID
Retrieve a single contact with full details including its account.
path Parameters
workspaceIdWorkspace UUID
idContact UUID
Get a contact by ID › Responses
Contact details
Update a contact
Change a contact's name, email, title, phone or primary flag. Only the fields you send change. Passing accountId moves the contact to another account in the same organization. A new email address is not checked against other contacts here: before giving a contact a new address, search list-contacts for it, because another contact may already have it.
path Parameters
workspaceIdWorkspace UUID
idThe contact's UUID: its id from list-contacts or get-contact.
Update a 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 a contact › Responses
Updated contact