- The Public ID is the plugin’s
key. - The Secret Key is a second account field. Pass it as
secretKeyor store it assecret_keyon the account.
X-Public-ID and X-Secret-Key). There is no single-token form.
Things to know before you write:
- A 200 can still mean failure. Every answer is an envelope,
{ success, message, data }, and SuiteDash reports some business errors withsuccess: falseon a 200. The plugin turns that into an error rather than handing it back as data. - The call limit is monthly, not per second. 80 calls on trial, 400 on Start, 2000 on Thrive, 20000 on Pinnacle, counted per account. A 429 means the allowance is used up, so the plugin never retries it.
- A company is addressed by uid or name, a contact by uid or email. SuiteDash decides which from the value, so no lookup step is needed. A project instead takes an explicit mode in the path:
uid,name,contains_the_followingormost_recent. - Custom fields need the account’s own keys. Every write that touches
public_custom_fields,private_custom_fieldsortarget_custom_fieldsuses keys that are uuids unique to the account. Read them fromcompanies.meta,contacts.metaorprojects.metafirst. - Custom fields read as an array. A response sends
public_custom_fieldsas an array, usually empty, even though the spec types it as an object. The output accepts both. - A company’s
roledecides portal access.Lead,ClientorProspect, and the same three values on a contact. The write example below omits it because the docs generator cannot render an enum in example arguments; see the API reference for the accepted values. - A contact create needs four fields. First name, last name, email and role are all required by the spec, and a company create can add its first contact via
primaryContactwithcreate_primary_contact_if_not_exists. - Paging. Lists report
meta.paginationwithtotalItems,totalPagesand anextPageURL. Passpageto advance. Themetaflag controls whether that block and the custom field definitions come back at all. - Marketing subscribe is all-or-nothing at the top. The answer carries one result per subscriber, and its top-level
successis true only when every one worked.
- 16 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the SuiteDash API key before the first call: More: API Key
pnpm corsair setup --plugin=suitedash --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
List contacts created this yearWhat’s next
API reference
Every
suitedash.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.