Productmind API

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

GET
https://api.productmind.ai
/workspaces/{workspaceId}/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.

List customer accounts › path Parameters

workspaceId
​string · required

Workspace UUID

List customer accounts › query Parameters

page
​number

Page number (1-indexed, default 1)

limit
​number

Items per page (default 50)

sortBy
​string · enum

Field to sort by

Enum values:
title
accountType
lifecycleState
relevance
sortOrder
​string · enum

Sort direction (default desc)

Enum values:
asc
desc
search
​string

Match the account name, case-insensitively, as one substring ("acme" finds Acme Corp).

organizationId
​string

Organization UUID (defaults to user's org)

accountType
​

Filter by account type (single value or array)

lifecycleState
​

Filter by lifecycle stage (single value or array)

tags
​

Filter by tag names (single value or comma-separated array)

List customer accounts › Responses

200

List of accounts

​AccountDTO[] · required
​object
​object

Create a customer account

POST
https://api.productmind.ai
/workspaces/{workspaceId}/accounts

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).

Create a customer account › path Parameters

workspaceId
​string · required

Workspace UUID

Create a customer account › Request Body

name
​string · minLength: 1 · maxLength: 100 · required

The company or organization's name, e.g. "Acme Corp". 1 to 100 characters.

accountType
​string · enum · required

What the company is to you: customer, partner, internal (your own company) or other.

Enum values:
internal
customer
partner
other
​

The company's website, as a full URL such as "https://www.example.com".

notes
​string · maxLength: 2000

Free-text notes about the account, up to 2000 characters.

sourceType
​string · enum

How 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.

Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string

The UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

isStrategic
​boolean

Whether this is a strategic account: one that matters especially to you, shown with a star.

estimatedArr
​number · min: 0

The account's estimated annual recurring revenue: a non-negative number with no currency symbol, e.g. 120000.

lifecycleState
​string · enum

Where the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.

Enum values:
prospect
trial
customer
expansion
at_risk
churned

Create a customer account › Responses

Created account

​AccountDTO · required

Get an account by ID

GET
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{id}

Retrieve a single customer account with its contacts.

Get an account by ID › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Account UUID

Get an account by ID › Responses

200

Account details

​AccountDTO · required

Update a customer account

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{id}

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").

Update a customer account › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

The account's UUID: its id from list-accounts or get-account.

Update a customer account › Request Body

name
​string · minLength: 1 · maxLength: 100

The company or organization's name, e.g. "Acme Corp". 1 to 100 characters.

accountType
​string · enum

What the company is to you: customer, partner, internal (your own company) or other.

Enum values:
internal
customer
partner
other
​

The company's website, as a full URL such as "https://www.example.com". Send "" to clear it.

notes
​string · maxLength: 2000

Free-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.

isStrategic
​boolean

Whether 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.

lifecycleState
​string · enum

Where the account is in its relationship with you: prospect, trial, customer, expansion, at_risk or churned.

Enum values:
prospect
trial
customer
expansion
at_risk
churned
externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

Update a customer account › Responses

200

Updated account

​AccountDTO · required

Delete a customer account

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{id}

Permanently remove a customer account and its contacts.

Delete a customer account › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Account UUID

Delete a customer account › Responses

200

Account deleted

No data returned

List contacts for an account

GET
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{accountId}/contacts

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.

List contacts for an account › path Parameters

workspaceId
​string · required

Workspace UUID

accountId
​string · required

Account UUID

List contacts for an account › Responses

200

List of contacts

​ContactDTO[] · required
​object
​object

Create a contact for an account

POST
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{accountId}/contacts

Add a person as a contact under a customer account.

Create a contact for an account › path Parameters

workspaceId
​string · required

Workspace UUID

accountId
​string · required

Account UUID

Create a contact for an account › Request Body

name
​string · minLength: 1 · maxLength: 100 · required

The 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.

title
​string · maxLength: 100

The person's job title or role, e.g. "Head of Operations". Up to 100 characters.

phone
​string · maxLength: 50

The person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.

accountId
​string

The 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.

isPrimary
​boolean

Whether 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.

sourceType
​string · enum

How 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.

Enum values:
manual
feedback_stream
research_interview
crm_import
sourceId
​string

The UUID of the Productmind record this one was created from, such as a feedback stream. Leave it out when adding one by hand.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

Create a contact for an account › Responses

Contact created

​ContactDTO · required

Update an account contact

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{accountId}/contacts/{id}

Modify contact details (name, email, title).

Update an account contact › path Parameters

workspaceId
​string · required

Workspace UUID

accountId
​string · required

Account UUID

id
​string · required

Contact UUID

Update an account contact › Request Body

name
​string · minLength: 1 · maxLength: 100

The 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.

title
​string · maxLength: 100

The person's job title or role, e.g. "Head of Operations". Up to 100 characters.

phone
​string · maxLength: 50

The person's phone number, as written, e.g. "+1 555 0100". Up to 50 characters.

accountId
​string

Moves 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.

isPrimary
​boolean

Whether 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.

externalSource
​string · enum

Which CRM this record was imported from.

Enum values:
google_contacts
hubspot
salesforce
externalId
​string · minLength: 1 · maxLength: 255

The CRM's own id for this record — people/c123…, 701.

externalSourceUrl
​string · uri

Deep link back to the record in the CRM.

releaseUpdatesOptOut
​boolean

true stops the release update emails to this person; false sends them again.

Update an account contact › Responses

200

Contact updated

​ContactDTO · required

Delete an account contact

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/accounts/{accountId}/contacts/{id}

Remove a contact from an account.

Delete an account contact › path Parameters

workspaceId
​string · required

Workspace UUID

accountId
​string · required

Account UUID

id
​string · required

Contact UUID

Delete an account contact › Responses

200

Contact deleted

No data returned