nutshell.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Accounts
create
accounts.create
Create an account
Risk: write
await corsair.nutshell.api.accounts.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
accounts?: {
name?: string,
description?: string,
phones?: {
isPrimary?: boolean,
name?: string,
value?: string
}[],
emails?: {
value?: string
}[],
urls?: {
value?: string
}[],
addresses?: {
name?: string,
isPrimary?: boolean,
value?: {
address_1?: string,
city?: string,
state?: string
}
}[],
links?: {
},
customFields?: {
}
}[]
}
object
Output full type
Output full type
((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
href?: string | null,
revenue?: {
amount?: string | number | null,
formatted?: string | null
} | null,
employeeCount?: number | null
}
createCustomField
accounts.createCustomField
Create a custom field
Risk: write
await corsair.nutshell.api.accounts.createCustomField({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
name?: any,
type?: any,
choices?: any,
isMultiple?: any,
id?: string,
title?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
customFieldAttributes
accounts.customFieldAttributes
Get a list of custom fields
Risk: read
await corsair.nutshell.api.accounts.customFieldAttributes({});
| Name | Type | Required | Description |
|---|---|---|---|
accounts | object[] | null | No | — |
accounts full type
accounts full type
{
id?: string | null
}[] | null
customfields
accounts.customfields
Get custom fields
Risk: read
await corsair.nutshell.api.accounts.customfields({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
customFields | object[] | null | No | — |
customFields full type
customFields full type
(
{
id?: string | null
}& {
value?: string | null,
id?: string | null
}
)[] | null
delete
accounts.delete
Delete an account
Risk: destructive
await corsair.nutshell.api.accounts.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
accounts | object[] | null | No | — |
creators | object[] | null | No | — |
owners | object[] | null | No | — |
origins | object[] | null | No | — |
contacts | object[] | null | No | — |
accountTypes | object[] | null | No | — |
industries | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
accounts full type
accounts full type
(((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
href?: string | null,
revenue?: {
amount?: string | number | null,
formatted?: string | null
} | null,
employeeCount?: number | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
creators full type
creators full type
(
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)[] | null
owners full type
owners full type
(
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)[] | null
origins full type
origins full type
((((
{
avatarUrl?: string | null,
initials?: string | null
}& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}
)& {
id?: string | null,
name?: string | null,
modifiedTime?: number | null,
lastseenTime?: number | null,
originType?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
contacts full type
contacts full type
(((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})[] | null
accountTypes full type
accountTypes full type
{
id?: string | null,
name?: string | null,
modifiedTime?: number | null
}[] | null
industries full type
industries full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null
}[] | null
get
accounts.get
Get an account
Risk: read
await corsair.nutshell.api.accounts.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
accounts | object[] | null | No | — |
creators | object[] | null | No | — |
owners | object[] | null | No | — |
origins | object[] | null | No | — |
contacts | object[] | null | No | — |
accountTypes | object[] | null | No | — |
industries | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
accounts full type
accounts full type
(((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
href?: string | null,
revenue?: {
amount?: string | number | null,
formatted?: string | null
} | null,
employeeCount?: number | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
creators full type
creators full type
(
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)[] | null
owners full type
owners full type
(
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)[] | null
origins full type
origins full type
((((
{
avatarUrl?: string | null,
initials?: string | null
}& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}
)& {
id?: string | null,
name?: string | null,
modifiedTime?: number | null,
lastseenTime?: number | null,
originType?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
contacts full type
contacts full type
(((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})[] | null
accountTypes full type
accountTypes full type
{
id?: string | null,
name?: string | null,
modifiedTime?: number | null
}[] | null
industries full type
industries full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null
}[] | null
list
accounts.list
Get a list of accounts
Risk: read
await corsair.nutshell.api.accounts.list({});
| Name | Type | Required | Description |
|---|---|---|---|
email | string | No | — |
q | string | No | — |
filter | object | No | — |
sort | (-accountType | -createdTime | -industry | -lastContactedTime | -name | -numberOfContacts | -owner | -phone | -postalCode | -territory | accountType | createdTime | industry | lastContactedTime | name | numberOfContacts | owner | phone | postalCode | territory)[] | No | — |
page[limit] | string | No | — |
page[page] | string | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
accounts | object[] | null | No | — |
meta full type
meta full type
((
{
count?: number | null
}& {
total?: number | null
}
)& {
facets?: {
AccountType?: {
n-accountTypes?: number | null
} | null
} | null
})& {
instanceId?: string | null,
siteId?: string | null
} | null
accounts full type
accounts full type
(((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
href?: string | null,
revenue?: {
amount?: string | number | null,
formatted?: string | null
} | null,
employeeCount?: number | null
})[] | null
listFields
accounts.listFields
Get the fields for an account
Risk: read
await corsair.nutshell.api.accounts.listFields({});
| Name | Type | Required | Description |
|---|---|---|---|
properties | object | null | No | — |
properties full type
properties full type
{
exampleProperty?: {
type?: string | null,
title?: string | null,
description?: string | null,
isFilterable?: boolean | null,
isDisplayable?: boolean | null,
isSortable?: boolean | null,
isGoalable?: boolean | null,
isAddable?: boolean | null,
isBoardable?: boolean | null,
isRequireable?: boolean | null,
isAndable?: boolean | null,
isNullable?: boolean | null,
relationships?: string[] | null,
enum?: string[] | null,
format?: string | null
} | null
} | null
listItems
accounts.listItems
Get list items for all accounts
Risk: read
await corsair.nutshell.api.accounts.listItems({});
| Name | Type | Required | Description |
|---|---|---|---|
filter | object | No | — |
q | string | No | — |
sort | (-accountType | -createdTime | -industry | -lastContactedTime | -name | -numberOfContacts | -owner | -phone | -postalCode | -territory | accountType | createdTime | industry | lastContactedTime | name | numberOfContacts | owner | phone | postalCode | territory)[] | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
listItems | object[] | null | No | — |
meta full type
meta full type
((
{
count?: number | null
}& {
total?: number | null
}
)& {
facets?: {
AccountType?: {
n-accountTypes?: number | null
} | null
} | null
})& {
instanceId?: string | null,
siteId?: string | null
} | null
listItems full type
listItems full type
(((((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
primaryName?: string | null,
primaryInfo?: string | null,
relatedName?: string | null,
relatedInfo?: string | null,
relatedType?: string | null,
relatedUrl?: string | null,
relatedUrlPath?: string | null,
primaryContact?: string | {
} | null,
primaryAccount?: string | {
} | null,
latlon?: string | string[] | null,
mapUrl?: string | null,
isDeleted?: boolean | null,
fields?: {
}[] | Record<string, any> | null
})& {
description?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
undelete
accounts.undelete
Undelete an account
Risk: write
await corsair.nutshell.api.accounts.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
href?: string | null,
revenue?: {
amount?: string | number | null,
formatted?: string | null
} | null,
employeeCount?: number | null
}
update
accounts.update
Update an account
Risk: write
await corsair.nutshell.api.accounts.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
undefined
Account Types
list
accountTypes.list
Get a list of account types
Risk: read
await corsair.nutshell.api.accountTypes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
accountTypes | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
accountTypes full type
accountTypes full type
{
id?: string | null,
name?: string | null,
modifiedTime?: number | null
}[] | null
Activities
create
activities.create
Create an activity
Risk: write
await corsair.nutshell.api.activities.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
activities?: {
name?: string,
description?: string,
note?: string,
location?: string,
activityType?: string,
startTime?: number,
endTime?: number,
transcription?: string,
isFlagged?: boolean,
isLogged?: boolean,
isAllDay?: boolean,
links?: {
participants?: string[],
leads?: string[]
}
}[]
}
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
activities?: (((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
id?: string | null
})[] | null,
id?: string | null,
agenda?: any | null,
createdTime?: number | null,
endTime?: number | null,
deletedTime?: number | null,
href?: string | null,
isAllDay?: boolean | null,
isEditable?: boolean | null,
isCancelled?: boolean | null,
isFlagged?: boolean | null,
isLogged?: boolean | null,
isOverdue?: boolean | null,
loggedTime?: number | null,
modifiedTime?: number | null,
name?: string | null,
startTime?: number | null,
isMediaLogged?: boolean | null,
transcription?: string | null
}
get
activities.get
Get an activity
Risk: read
await corsair.nutshell.api.activities.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
activities?: (((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
id?: string | null
})[] | null,
id?: string | null,
agenda?: any | null,
createdTime?: number | null,
endTime?: number | null,
deletedTime?: number | null,
href?: string | null,
isAllDay?: boolean | null,
isEditable?: boolean | null,
isCancelled?: boolean | null,
isFlagged?: boolean | null,
isLogged?: boolean | null,
isOverdue?: boolean | null,
loggedTime?: number | null,
modifiedTime?: number | null,
name?: string | null,
startTime?: number | null,
isMediaLogged?: boolean | null,
transcription?: string | null
}
list
activities.list
Get activities
Risk: read
await corsair.nutshell.api.activities.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
limit | number | No | — |
filter[participant][] | string[] | No | — |
filter[status][] | (scheduled | logged | cancelled)[] | No | — |
filter[leadPriority][] | hot | No | — |
filter[activityType] | number[] | No | — |
filter[flagged] | boolean | No | — |
filter[isImportant] | boolean | No | — |
filter[dateMin] | string | No | — |
filter[dateMax] | string | No | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
activities?: (((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
id?: string | null
})[] | null,
id?: string | null,
agenda?: any | null,
createdTime?: number | null,
endTime?: number | null,
deletedTime?: number | null,
href?: string | null,
isAllDay?: boolean | null,
isEditable?: boolean | null,
isCancelled?: boolean | null,
isFlagged?: boolean | null,
isLogged?: boolean | null,
isOverdue?: boolean | null,
loggedTime?: number | null,
modifiedTime?: number | null,
name?: string | null,
startTime?: number | null,
isMediaLogged?: boolean | null,
transcription?: string | null
}
update
activities.update
Update an activity
Risk: write
await corsair.nutshell.api.activities.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object | Yes | — |
body full type
body full type
{
activities?: {
name?: string,
description?: string,
note?: string,
location?: string,
activityType?: string,
startTime?: number,
endTime?: number,
transcription?: string,
isFlagged?: boolean,
isLogged?: boolean,
isAllDay?: boolean,
links?: {
participants?: string[],
leads?: string[]
}
}[]
}
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
activities?: (((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
id?: string | null
})[] | null,
id?: string | null,
agenda?: any | null,
createdTime?: number | null,
endTime?: number | null,
deletedTime?: number | null,
href?: string | null,
isAllDay?: boolean | null,
isEditable?: boolean | null,
isCancelled?: boolean | null,
isFlagged?: boolean | null,
isLogged?: boolean | null,
isOverdue?: boolean | null,
loggedTime?: number | null,
modifiedTime?: number | null,
name?: string | null,
startTime?: number | null,
isMediaLogged?: boolean | null,
transcription?: string | null
}
Activity Types
list
activityTypes.list
Get activity types
Risk: read
await corsair.nutshell.api.activityTypes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
activityTypes | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
activityTypes full type
activityTypes full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null,
isBenchmarkable?: boolean | null
}[] | null
Audiences
create
audiences.create
Create an audience
Risk: write
await corsair.nutshell.api.audiences.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
emAudiences?: {
name?: string
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
emAudiences | object[] | null | No | — |
emAudiences full type
emAudiences full type
{
id?: string | null,
type?: string | null,
name?: string | null,
isWebFX?: boolean | null
}[] | null
list
audiences.list
Get a list of audiences
Risk: read
await corsair.nutshell.api.audiences.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
emAudiences | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
emAudiences full type
emAudiences full type
{
id?: string | null,
name?: string | null,
isWebFX?: boolean | null
}[] | null
Competitor Maps
delete
competitorMaps.delete
Delete a lead-competitor relationship
Risk: destructive · Irreversible
await corsair.nutshell.api.competitorMaps.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
undefined
get
competitorMaps.get
Get a lead-competitor relationship
Risk: read
await corsair.nutshell.api.competitorMaps.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
competitorMaps | object[] | null | No | — |
leads | object[] | null | No | — |
competitors | object[] | null | No | — |
competitorMaps full type
competitorMaps full type
{
id?: string | null,
relationship?: string | null,
name?: string | null,
status?: string | null | null,
links?: {
lead?: string | null,
competitor?: string | null
} | null
}[] | null
leads full type
leads full type
((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})[] | null
competitors full type
competitors full type
{
id?: string | null
}[] | null
list
competitorMaps.list
Get a list of lead-competitor relationships
Risk: read
await corsair.nutshell.api.competitorMaps.list({});
| Name | Type | Required | Description |
|---|---|---|---|
competitorMaps | object[] | null | No | — |
leads | object[] | null | No | — |
competitors | object[] | null | No | — |
competitorMaps full type
competitorMaps full type
{
id?: string | null,
relationship?: string | null,
name?: string | null,
status?: string | null | null,
links?: {
lead?: string | null,
competitor?: string | null
} | null
}[] | null
leads full type
leads full type
((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})[] | null
competitors full type
competitors full type
{
id?: string | null
}[] | null
update
competitorMaps.update
Update a lead-competitor relationship
Risk: write
await corsair.nutshell.api.competitorMaps.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
undefined
Competitors
get
competitors.get
Get a competitor
Risk: read
await corsair.nutshell.api.competitors.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
competitors | any | null | No | — |
id | string | null | No | — |
name | string | null | No | — |
modifiedTime | number | null | No | — |
list
competitors.list
Get a list of competitors
Risk: read
await corsair.nutshell.api.competitors.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
competitors | any | null | No | — |
id | string | null | No | — |
name | string | null | No | — |
modifiedTime | number | null | No | — |
Contacts
create
contacts.create
Create a contact
Risk: write
await corsair.nutshell.api.contacts.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
contacts?: {
name?: string,
description?: string,
phones?: {
isOptedOut?: boolean,
isPrimary?: boolean,
name?: string,
value?: {
countryCode?: string,
number?: string,
extension?: string,
numberFormatted?: string,
E164?: string,
countryCodeAndNumber?: string
}
}[],
emails?: {
isPrimary?: boolean,
name?: string,
value?: string
}[],
urls?: {
isPrimary?: boolean,
name?: string,
value?: string
}[],
addresses?: {
isPrimary?: boolean,
name?: string,
value?: {
location?: {
longitude?: number,
latitude?: number
}
},
locationAccuracy?: string,
address_1?: string,
address_2?: string,
address_3?: string,
city?: string,
state?: string,
postalCode?: string,
country?: string,
timezone?: string
}[],
customFields?: {
},
links?: {
accounts?: string[],
territory?: string,
owner?: string,
tags?: string[],
emAudiences?: string[]
}
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
links | object | null | No | — |
contacts | object[] | null | No | — |
links full type
links full type
{
} | null
contacts full type
contacts full type
((((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})& {
links?: {
} | null
})[] | null
createCustomField
contacts.createCustomField
Create a custom field
Risk: write
await corsair.nutshell.api.contacts.createCustomField({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
name?: any,
type?: any,
choices?: any,
isMultiple?: any,
id?: string,
title?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
customFieldAttributes
contacts.customFieldAttributes
Get applicable custom fields
Risk: read
await corsair.nutshell.api.contacts.customFieldAttributes({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
contacts | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
contacts full type
contacts full type
{
id?: string | null
}[] | null
customfields
contacts.customfields
Get contact custom fields
Risk: read
await corsair.nutshell.api.contacts.customfields({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
customFields | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
customFields full type
customFields full type
{
id?: string | null
}[] | null
delete
contacts.delete
Delete a contact
Risk: destructive
await corsair.nutshell.api.contacts.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
contacts | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
contacts full type
contacts full type
{
id?: string | null
}[] | null
get
contacts.get
Get a contact
Risk: read
await corsair.nutshell.api.contacts.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
links | object | null | No | — |
contacts | object[] | null | No | — |
links full type
links full type
{
} | null
contacts full type
contacts full type
((((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})& {
links?: {
} | null
})[] | null
list
contacts.list
Get a list of contacts
Risk: read
await corsair.nutshell.api.contacts.list({});
| Name | Type | Required | Description |
|---|---|---|---|
email | string | No | — |
q | string | No | — |
sort | accountType | -accountType | accounts | -accounts | createdTime | -createdTime | email | -email | industry | -industry | lastContactedTime | -lastContactedTime | name | -name | owner | -owner | phone | -phone | postalCode | -postalCode | territory | -territory | No | — |
filter | object | No | — |
page[page] | number | No | — |
page[limit] | number | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
links | object | null | No | — |
contacts | object[] | null | No | — |
links full type
links full type
{
} | null
contacts full type
contacts full type
((((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})& {
links?: {
} | null
})[] | null
listFields
contacts.listFields
Get the fields for a contact
Risk: read
await corsair.nutshell.api.contacts.listFields({});
| Name | Type | Required | Description |
|---|---|---|---|
properties | object | null | No | — |
properties full type
properties full type
{
exampleProperty?: {
type?: string | null,
title?: string | null,
description?: string | null,
isFilterable?: boolean | null,
isDisplayable?: boolean | null,
isSortable?: boolean | null,
isGoalable?: boolean | null,
isAddable?: boolean | null,
isBoardable?: boolean | null,
isRequireable?: boolean | null,
isAndable?: boolean | null,
isNullable?: boolean | null,
relationships?: string[] | null,
enum?: string[] | null,
format?: string | null
} | null
} | null
listItems
contacts.listItems
Get list items for all contacts
Risk: read
await corsair.nutshell.api.contacts.listItems({});
| Name | Type | Required | Description |
|---|---|---|---|
filter | object | No | — |
q | string | No | — |
sort | (-accountType | -accounts | -createdTime | -industry | -lastContactedTime | -owner | -phone | -postalCode | -territory | accountType | accounts | createdTime | industry | lastContactedTime | owner | phone | postalCode | territory)[] | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
listItems | object[] | null | No | — |
meta full type
meta full type
(
{
count?: number | null
}& {
total?: number | null
}
)& {
instanceId?: string | null,
siteId?: string | null
} | null
listItems full type
listItems full type
(((((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
primaryName?: string | null,
primaryInfo?: string | null,
relatedName?: string | null,
relatedInfo?: string | null,
relatedType?: string | null,
relatedUrl?: string | null,
relatedUrlPath?: string | null,
primaryContact?: string | {
} | null,
primaryAccount?: string | {
} | null,
latlon?: string | string[] | null,
mapUrl?: string | null,
isDeleted?: boolean | null,
fields?: {
}[] | Record<string, any> | null
})& {
description?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
undelete
contacts.undelete
Undelete a contact
Risk: write
await corsair.nutshell.api.contacts.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
links | object | null | No | — |
contacts | object[] | null | No | — |
links full type
links full type
{
} | null
contacts full type
contacts full type
((((((
{
id?: string | null,
name?: string | null,
description?: string | null,
createdTime?: number | null,
deletedTime?: number | null,
emails?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null,
addresses?: {
isPrimary?: boolean | null,
name?: string | null,
value?: {
location?: {
longitude?: number | null,
latitude?: number | null
} | null
} | null,
locationAccuracy?: string | null,
address_1?: string | null,
address_2?: string | null,
address_3?: string | null,
city?: string | null,
state?: string | null,
postalCode?: string | null,
country?: string | null,
timezone?: string | null
}[] | null,
phones?: {
isOptedOut?: boolean | null,
isPrimary?: boolean | null,
name?: string | null,
value?: {
countryCode?: string | null,
number?: string | null,
extension?: string | null,
numberFormatted?: string | null,
E164?: string | null,
countryCodeAndNumber?: string | null
} | null
}[] | null,
urls?: {
isPrimary?: boolean | null,
name?: string | null,
value?: string | null
}[] | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
jobTitle?: any | null,
firstName?: any | null,
lastName?: any | null,
href?: string | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})& {
links?: {
} | null
})[] | null
update
contacts.update
Update a contact
Risk: write
await corsair.nutshell.api.contacts.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
contacts | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
contacts full type
contacts full type
{
id?: string | null
}[] | null
Dashboards
listFields
dashboards.listFields
Get dashboard field definitions
Risk: read
await corsair.nutshell.api.dashboards.listFields({});
| Name | Type | Required | Description |
|---|---|---|---|
$schema | string | Yes | — |
type | object | Yes | — |
description | string | Yes | — |
properties | object | Yes | — |
properties full type
properties full type
{
stageset?: {
type: enum,
enum: {
id: string,
type: stagesets,
name: string
}[],
title: string,
description: string,
isFilterable: boolean,
isDisplayable: boolean,
isSortable: boolean,
isAndable: boolean,
isNullable: boolean,
size: string
} | null
}
Editions
get
editions.get
Get a single edition by its ID
Risk: read
await corsair.nutshell.api.editions.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
list
editions.list
Get a list of editions
Risk: read
await corsair.nutshell.api.editions.list({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
Emails
get
emails.get
Get an email
Risk: read
await corsair.nutshell.api.emails.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
Events
deleted
events.deleted
Get deletion events
Risk: read
await corsair.nutshell.api.events.deleted({});
| Name | Type | Required | Description |
|---|---|---|---|
filter[types] | accounts | activities | assignments | chats | companyEnrichment | constantContact | contacts | emails | emailInteraction | formSubmissions | inbox_threads | leadUpdates | leads | marketingEmails | mcfxSessions | notes | queued | ticketMessages | undelivered | unshared | No | — |
sort | -change_time | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
events | object[] | null | No | — |
meta full type
meta full type
(
{
instanceId?: string | null,
siteId?: string | null
}& {
previous?: string | null
}
)& {
next?: string | null
} | null
events full type
events full type
(
{
id?: string | null,
createdTime?: number | null,
actorType?: string | null,
payloadType?: string | null,
action?: string | null,
changes?: {
attribute?: string | null,
oldValue?: string | number | boolean | {
id?: string | null,
type?: string | null,
name?: string | null,
position?: number | null
} | null,
newValue?: string | number | boolean | {
id?: string | null,
type?: string | null,
name?: string | null,
position?: number | null
} | null
}[] | null,
count?: string | null
}& {
links?: {
actor?: string | null,
payloads?: string[] | null,
comments?: string[] | null
} | null
}
)[] | null
list
events.list
Get a list of events
Risk: read
await corsair.nutshell.api.events.list({});
| Name | Type | Required | Description |
|---|---|---|---|
max_id | string | No | — |
since_id | string | No | — |
max_time | number | No | — |
since_time | number | No | — |
entity_id | string | No | — |
limit | number | No | — |
events | (comments | mailchimp | followup | constantContact | emailInteraction | assignments | formSubmissions)[] | No | — |
filters[payload][] | (accounts | activities | assignments | chats | companyEnrichment | constantContact | contacts | emails | emailInteraction | formSubmissions | inbox_threads | leadUpdates | leads | marketingEmails | mcfxSessions | notes | queued | ticketMessages | undelivered | unshared)[] | No | — |
filters[creator][] | string[] | No | — |
filters[emailEntityType][] | (sender | recipient)[] | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
events | object[] | null | No | — |
meta full type
meta full type
(
{
instanceId?: string | null,
siteId?: string | null
}& {
previous?: string | null
}
)& {
next?: string | null
} | null
events full type
events full type
(
{
id?: string | null,
createdTime?: number | null,
actorType?: string | null,
payloadType?: string | null,
action?: string | null,
changes?: {
attribute?: string | null,
oldValue?: string | number | boolean | {
id?: string | null,
type?: string | null,
name?: string | null,
position?: number | null
} | null,
newValue?: string | number | boolean | {
id?: string | null,
type?: string | null,
name?: string | null,
position?: number | null
} | null
}[] | null,
count?: string | null
}& {
links?: {
actor?: string | null,
payloads?: string[] | null,
comments?: string[] | null
} | null
}
)[] | null
Filters
list
filters.list
Get saved filters
Risk: read
await corsair.nutshell.api.filters.list({});
| Name | Type | Required | Description |
|---|---|---|---|
userId | string | No | — |
reportType | report_* | entity_list_leads | entity_list_contacts | entity_list_accounts | No | — |
filter | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
filters | object[] | null | No | — |
filters full type
filters full type
{
id?: string | null,
name?: string | null
}[] | null
Forms
get
forms.get
Get a form
Risk: read
await corsair.nutshell.api.forms.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
meta?: {
instanceId?: string | null,
siteId?: string | null
} | null,
links?: {
} | null,
wfForms?: (
{
id?: string | null,
name?: string | null,
href?: string | null,
createdTime?: string | null
}& {
links?: {
fields?: string[] | null
} | null
}
)[] | null
}& {
wfFields?: {
id?: string | null,
label?: string | null,
fieldName?: string | null,
fieldType?: string | null,
entityName?: string | null
}[] | null
}
getFieldId
forms.getFieldId
Get a form field
Risk: read
await corsair.nutshell.api.forms.getFieldId({});
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
wfFields | object[] | null | No | — |
wfFields full type
wfFields full type
{
id?: string | null,
label?: string | null,
fieldName?: string | null,
fieldType?: string | null,
entityName?: string | null
}[] | null
list
forms.list
Get all forms
Risk: read
await corsair.nutshell.api.forms.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
wfForms | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
wfForms full type
wfForms full type
(
{
id?: string | null,
name?: string | null,
href?: string | null,
createdTime?: string | null
}& {
links?: {
fields?: string[] | null
} | null
}
)[] | null
Industries
get
industries.get
Get a single industry by its ID
Risk: read
await corsair.nutshell.api.industries.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | any | null | No | — |
modifiedTime | number | null | No | — |
list
industries.list
Get a list of industries
Risk: read
await corsair.nutshell.api.industries.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
industries | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
industries full type
industries full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null
}[] | null
Invoices
get
invoices.get
Get an invoice
Risk: read
await corsair.nutshell.api.invoices.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
invoices full type
invoices full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
paidTime?: string | null,
completionComment?: string | null,
deletedTime?: string | number | null
}
)[] | null
list
invoices.list
Get a list of invoices
Risk: read
await corsair.nutshell.api.invoices.list({});
| Name | Type | Required | Description |
|---|---|---|---|
filter[lead] | string | No | — |
filter[dateMin] | string | No | — |
filter[dateMax] | string | No | — |
page[limit] | string | No | — |
page[page] | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
meta | object | null | No | — |
links | object | null | No | — |
invoices full type
invoices full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
paidTime?: string | null,
completionComment?: string | null,
deletedTime?: string | number | null
}
)[] | null
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
status
invoices.status
Update the status of an invoice
Risk: write
await corsair.nutshell.api.invoices.status({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object | Yes | — |
body full type
body full type
{
status: READY | SENT | REVOKED | ACCEPTED | ARCHIVED,
comment?: string,
acceptedName?: string,
acceptedEmail?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
invoices full type
invoices full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
paidTime?: string | null,
completionComment?: string | null,
deletedTime?: string | number | null
}
)[] | null
Leads
create
leads.create
Create a lead
Risk: write
await corsair.nutshell.api.leads.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
leads?: {
description?: string,
manualValue?: string,
dueTime?: {
absoluteLocalizedString?: string,
timestamp?: number,
value?: string
},
customFields?: {
},
links?: {
accounts?: string[],
contacts?: string[],
owner?: string,
sources?: string[],
tags?: string[],
productMaps?: {
id?: string,
relationship?: any,
price?: {
formatted?: string,
amount?: string,
currency?: string
},
name?: any,
unit?: any,
quantity?: number,
productType?: string,
links?: {
product?: string
}
}[],
competitorMaps?: string[]
}
}[]
}
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
createCustomField
leads.createCustomField
Create a custom field
Risk: write
await corsair.nutshell.api.leads.createCustomField({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
name?: any,
type?: any,
choices?: any,
isMultiple?: any,
id?: string,
title?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
customFieldAttributes
leads.customFieldAttributes
Get applicable custom fields for leads
Risk: read
await corsair.nutshell.api.leads.customFieldAttributes({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
leads | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
leads full type
leads full type
{
id?: string | null
}[] | null
customfields
leads.customfields
Get a lead’s custom fields
Risk: read
await corsair.nutshell.api.leads.customfields({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
customFields | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
customFields full type
customFields full type
(
{
id?: string | null
}& {
value?: string | null,
id?: string | null
}
)[] | null
delete
leads.delete
Delete a lead
Risk: destructive
await corsair.nutshell.api.leads.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
get
leads.get
Get a lead
Risk: read
await corsair.nutshell.api.leads.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | Yes | — |
links | object | Yes | — |
leads | object[] | Yes | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}
links full type
links full type
{
}
leads full type
leads full type
(((((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})& {
attributionTracking: {
gclid: string[],
fbclid: string[],
msclkid: string[],
lifatid: string[],
wbraid: string[],
gbraid: string[]
}
})[]
installments
leads.installments
Get installments for a lead
Risk: read
await corsair.nutshell.api.leads.installments({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
installments | object[] | Yes | — |
installments full type
installments full type
{
id?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
description?: string | null,
value?: {
currency?: string | null,
amount?: string | number | null
} | null,
failedTime?: string | null,
isPaid?: boolean | null
}[]
list
leads.list
Get a list of leads
Risk: read
await corsair.nutshell.api.leads.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
sort | -age | -value | -milestone | -confidence | -name | -closedTime | -owner | -sources | age | value | milestone | confidence | name | closedTime | owner | sources | No | — |
filter | object | No | — |
page[page] | number | No | — |
page[limit] | number | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
leads | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
leads full type
leads full type
((((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
listFields
leads.listFields
Get the fields for a lead
Risk: read
await corsair.nutshell.api.leads.listFields({});
| Name | Type | Required | Description |
|---|---|---|---|
properties | object | null | No | — |
properties full type
properties full type
{
exampleProperty?: {
type?: string | null,
title?: string | null,
description?: string | null,
isFilterable?: boolean | null,
isDisplayable?: boolean | null,
isSortable?: boolean | null,
isGoalable?: boolean | null,
isAddable?: boolean | null,
isBoardable?: boolean | null,
isRequireable?: boolean | null,
isAndable?: boolean | null,
isNullable?: boolean | null,
relationships?: string[] | null,
enum?: string[] | null,
format?: string | null
} | null
} | null
listItems
leads.listItems
Get list items for all leads
Risk: read
await corsair.nutshell.api.leads.listItems({});
| Name | Type | Required | Description |
|---|---|---|---|
filter | object | No | — |
q | string | No | — |
sort | -age | -value | -milestone | -confidence | -name | -closedTime | -owner | -sources | age | value | milestone | confidence | name | closedTime | owner | sources | No | — |
filter full type
filter full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
listItems | object[] | null | No | — |
meta full type
meta full type
(
{
count?: number | null
}& {
total?: number | null
}
)& {
instanceId?: string | null,
siteId?: string | null
} | null
listItems full type
listItems full type
((((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
primaryName?: string | null,
primaryInfo?: string | null,
relatedName?: string | null,
relatedInfo?: string | null,
relatedType?: string | null,
relatedUrl?: string | null,
relatedUrlPath?: string | null,
primaryContact?: string | {
} | null,
primaryAccount?: string | {
} | null,
latlon?: string | string[] | null,
mapUrl?: string | null,
isDeleted?: boolean | null,
fields?: {
}[] | Record<string, any> | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
postStageset
leads.postStageset
Set the pipeline for a lead
Risk: write
await corsair.nutshell.api.leads.postStageset({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object | No | — |
body full type
body full type
{
stageset?: string
}
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
reopen
leads.reopen
Reopen a lead
Risk: write
await corsair.nutshell.api.leads.reopen({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
report
leads.report
Get reports for a lead
Risk: read
await corsair.nutshell.api.leads.report({});
| Name | Type | Required | Description |
|---|---|---|---|
filter[name] | string | No | — |
q | string | No | — |
sort | string | No | — |
format | json | csv | html | No | — |
gap | d | w | m | y | q | No | — |
groupByField | string | No | — |
pivotFacet | string | No | — |
reportType | sales | losses | newleads | forecast | attribution | custom | No | — |
segmentByField | outcomes | competitors | products | productCategories | assignees | territories | sources | tags | channels | No | — |
useConfidence | boolean | No | — |
object \| string
Output full type
Output full type
{
reports?: {
report?: {
id?: string | null,
key?: string | null,
data?: {
bucket?: {
bucket?: string | null,
count?: {
formatted?: string | null,
prefix?: string | null,
suffix?: string | null,
value?: number | null
} | null,
total?: {
formatted?: string | null,
prefix?: string | null,
suffix?: string | null,
value?: number | null
} | null,
bucketType?: string | null,
bucketSubtype?: string | null,
filters?: string[] | null,
segments?: string[] | null
} | null
}[] | null,
name?: string | null,
prefix?: string | null,
summary?: {
bucket?: string | null,
count?: {
formatted?: string | null,
prefix?: string | null,
suffix?: string | null,
value?: number | null
} | null,
total?: {
formatted?: string | null,
prefix?: string | null,
suffix?: string | null,
value?: number | null
} | null,
bucketType?: string | null,
bucketSubtype?: string | null,
filters?: string[] | null,
segments?: string[] | null
} | null
} | null
}[] | null
} | string
stages
leads.stages
Get all stages associated with lead
Risk: read
await corsair.nutshell.api.leads.stages({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
stages | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}& {
timeSpent?: {
formatted?: string | null,
prefix?: string | null,
suffix?: string | null,
value?: number | null,
unit?: string | null
}[] | null,
stageset?: {
id?: string | null,
name?: any | null,
default?: boolean | null,
canAccess?: boolean | null,
status?: string | number | null
} | null
} | null
stages full type
stages full type
{
id?: string | null,
name?: string | null,
description?: string | null,
position?: number | null,
activeAvatarUrl?: string | null,
completeAvatarUrl?: string | null,
incompleteAvatarUrl?: string | null,
overdueAvatarUrl?: string | null,
numSteps?: number | null,
canAdvanceStage?: boolean | null,
links?: {
stageset?: string | null
} | null
}[] | null
status
leads.status
Update the status of a lead
Risk: write
await corsair.nutshell.api.leads.status({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object | No | — |
body full type
body full type
{
outcomeId?: string,
competitorMaps?: string[],
productMaps?: {
id?: string,
relationship?: any,
price?: {
formatted?: string,
amount?: string,
currency?: string
},
name?: any,
unit?: any,
quantity?: number,
productType?: string,
links?: {
product?: string
}
}[]
}
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
undelete
leads.undelete
Undelete a lead
Risk: write
await corsair.nutshell.api.leads.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
update
leads.update
Update a lead
Risk: write
await corsair.nutshell.api.leads.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
undefined
updateInstallments
leads.updateInstallments
Replace a lead’s installment schedule
Risk: destructive
await corsair.nutshell.api.leads.updateInstallments({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
id?: string,
dueTime: string,
description?: string,
value: string,
isFailed: boolean
}[]
| Name | Type | Required | Description |
|---|---|---|---|
installments | object[] | Yes | — |
installments full type
installments full type
{
id?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
description?: string | null,
value?: {
currency?: string | null,
amount?: string | number | null
} | null,
failedTime?: string | null,
isPaid?: boolean | null
}[]
watch
leads.watch
Watch a lead
Risk: write
await corsair.nutshell.api.leads.watch({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
(((
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
avatarUrl?: string | null,
initials?: string | null
}
)& {
id?: string | null,
deletedTime?: string | number | null,
name?: string | null,
value?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
number?: string | number | null,
description?: string | null,
createdTime?: {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
closedTime?: string | null,
dueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
anticipatedClosedTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
ownerType?: string | null,
status?: string | null,
lastContactedTime?: any | null,
pieState?: string | null,
isOverdue?: boolean | null,
overdueTime?: string | {
absoluteLocalizedString?: string | null,
timestamp?: number | null,
value?: string | null
} | null,
href?: string | null,
confidence?: number | null,
priority?: number | null,
isCurrentUserWatching?: boolean | null
})& {
htmlUrl?: string | null,
htmlUrlPath?: string | null
})& {
avatarUrl?: string | null,
initials?: string | null
}
Markets
get
markets.get
Get a market by the ID
Risk: read
await corsair.nutshell.api.markets.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
currency | string | null | No | — |
currencySymbol | string | null | No | — |
isDefault | boolean | null | No | — |
list
markets.list
Get a list of markets
Risk: read
await corsair.nutshell.api.markets.list({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
currency | string | null | No | — |
currencySymbol | string | null | No | — |
isDefault | boolean | null | No | — |
Notes
create
notes.create
Create a note
Risk: write
await corsair.nutshell.api.notes.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
data?: {
body?: any,
links?: {
parent?: string
}
}
}
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
createdTime?: string | null,
deletedTime?: string | number | null,
href?: string | null,
body?: string | null,
bodyHtml?: string | null,
bodyMarkup?: string | null,
isEditable?: boolean | null,
parentType?: string | null
}
delete
notes.delete
Delete a note
Risk: destructive
await corsair.nutshell.api.notes.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
createdTime?: string | null,
deletedTime?: string | number | null,
href?: string | null,
body?: string | null,
bodyHtml?: string | null,
bodyMarkup?: string | null,
isEditable?: boolean | null,
parentType?: string | null
}
get
notes.get
Get a note
Risk: read
await corsair.nutshell.api.notes.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
createdTime?: string | null,
deletedTime?: string | number | null,
href?: string | null,
body?: string | null,
bodyHtml?: string | null,
bodyMarkup?: string | null,
isEditable?: boolean | null,
parentType?: string | null
}
list
notes.list
Get a list of notes
Risk: read
await corsair.nutshell.api.notes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
page[limit] | string | No | — |
page[page] | string | No | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
createdTime?: string | null,
deletedTime?: string | number | null,
href?: string | null,
body?: string | null,
bodyHtml?: string | null,
bodyMarkup?: string | null,
isEditable?: boolean | null,
parentType?: string | null
}
undelete
notes.undelete
Undelete a note
Risk: write
await corsair.nutshell.api.notes.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
createdTime?: string | null,
deletedTime?: string | number | null,
href?: string | null,
body?: string | null,
bodyHtml?: string | null,
bodyMarkup?: string | null,
isEditable?: boolean | null,
parentType?: string | null
}
Outcomes
get
outcomes.get
Get a lead outcome by ID
Risk: read
await corsair.nutshell.api.outcomes.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | null | No | — |
name | string | null | No | — |
status | string | null | No | — |
type | string | null | No | — |
list
outcomes.list
Get a list of lead outcomes
Risk: read
await corsair.nutshell.api.outcomes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
outcomes | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
outcomes full type
outcomes full type
{
id?: string | null,
name?: string | null,
status?: string | null,
type?: string | null
}[] | null
Product Categories
create
productCategories.create
Create a product category
Risk: write
await corsair.nutshell.api.productCategories.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
productCategories?: {
name?: string
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
productCategories | object[] | null | No | — |
productCategories full type
productCategories full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null,
href?: any | null
}[] | null
get
productCategories.get
Get a product category
Risk: read
await corsair.nutshell.api.productCategories.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
productCategories | object[] | null | No | — |
productCategories full type
productCategories full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null,
href?: any | null
}[] | null
list
productCategories.list
List all product categories
Risk: read
await corsair.nutshell.api.productCategories.list({});
| Name | Type | Required | Description |
|---|---|---|---|
productCategories | object[] | null | No | — |
productCategories full type
productCategories full type
{
id?: string | null,
name?: any | null,
modifiedTime?: number | null,
href?: any | null
}[] | null
Product Maps
delete
productMaps.delete
Delete a product on a lead
Risk: destructive · Irreversible
await corsair.nutshell.api.productMaps.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
productMaps | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
productMaps full type
productMaps full type
{
id?: string | null,
relationship?: any | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
name?: any | null,
unit?: any | null,
quantity?: number | null,
productType?: string | null,
links?: {
product?: string | null
} | null
}[] | null
get
productMaps.get
Get lead product
Risk: read
await corsair.nutshell.api.productMaps.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
productMaps | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
productMaps full type
productMaps full type
{
id?: string | null,
relationship?: any | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
name?: any | null,
unit?: any | null,
quantity?: number | null,
productType?: string | null,
links?: {
product?: string | null
} | null
}[] | null
list
productMaps.list
Get lead products
Risk: read
await corsair.nutshell.api.productMaps.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
productMaps | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
productMaps full type
productMaps full type
{
id?: string | null,
relationship?: any | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
name?: any | null,
unit?: any | null,
quantity?: number | null,
productType?: string | null,
links?: {
product?: string | null
} | null
}[] | null
update
productMaps.update
Update a lead’s product information
Risk: write
await corsair.nutshell.api.productMaps.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
undefined
Products
delete
products.delete
Delete a product
Risk: destructive
await corsair.nutshell.api.products.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
products | object[] | null | No | — |
products full type
products full type
{
id?: string | null,
name?: any | null,
href?: any | null,
description?: any | null,
modifiedTime?: number | null,
deletedTime?: string | number | null,
sku?: any | null,
productType?: any | null,
prices?: {
1-markets?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
} | null,
price?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
}[] | null
get
products.get
Get a product
Risk: read
await corsair.nutshell.api.products.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
products | object[] | null | No | — |
products full type
products full type
{
id?: string | null,
name?: any | null,
href?: any | null,
description?: any | null,
modifiedTime?: number | null,
deletedTime?: string | number | null,
sku?: any | null,
productType?: any | null,
prices?: {
1-markets?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
} | null,
price?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
}[] | null
list
products.list
List or search products
Risk: read
await corsair.nutshell.api.products.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
sort | name | -name | sku | -sku | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
products | object[] | null | No | — |
products full type
products full type
{
id?: string | null,
name?: any | null,
href?: any | null,
description?: any | null,
modifiedTime?: number | null,
deletedTime?: string | number | null,
sku?: any | null,
productType?: any | null,
prices?: {
1-markets?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
} | null,
price?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
}[] | null
undelete
products.undelete
Undelete a product
Risk: write
await corsair.nutshell.api.products.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
products | object[] | null | No | — |
products full type
products full type
{
id?: string | null,
name?: any | null,
href?: any | null,
description?: any | null,
modifiedTime?: number | null,
deletedTime?: string | number | null,
sku?: any | null,
productType?: any | null,
prices?: {
1-markets?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
} | null,
price?: {
amount?: string | number | null,
currency?: string | null,
formatted?: string | null,
currencySymbol?: string | null
} | null
}[] | null
Quotes
createInvoice
quotes.createInvoice
Create an invoice from a quote
Risk: write
await corsair.nutshell.api.quotes.createInvoice({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | null | No | — |
invoices full type
invoices full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
paidTime?: string | null,
completionComment?: string | null,
deletedTime?: string | number | null
}
)[] | null
get
quotes.get
Get a quote
Risk: read
await corsair.nutshell.api.quotes.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
quotes | object[] | null | No | — |
quotes full type
quotes full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
acceptedTime?: string | null,
deletedTime?: string | number | null
}
)[] | null
list
quotes.list
Get a list of quotes
Risk: read
await corsair.nutshell.api.quotes.list({});
| Name | Type | Required | Description |
|---|---|---|---|
filter[lead] | string | No | — |
filter[dateMin] | string | No | — |
filter[dateMax] | string | No | — |
page[limit] | string | No | — |
page[page] | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
quotes | object[] | null | No | — |
meta | object | null | No | — |
links | object | null | No | — |
quotes full type
quotes full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
acceptedTime?: string | null,
deletedTime?: string | number | null
}
)[] | null
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
status
quotes.status
Update the status of a quote
Risk: write
await corsair.nutshell.api.quotes.status({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object | Yes | — |
body full type
body full type
{
status: READY | SENT | REVOKED | ACCEPTED | ARCHIVED,
acceptedName?: string,
acceptedEmail?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
quotes | object[] | null | No | — |
quotes full type
quotes full type
(
{
id?: string | null,
displayStatus?: DRAFT | READY | SENT | REVOKED | ACCEPTED | ARCHIVED | EXPIRED | null,
productLineItems?: {
id?: string | null,
position?: number | null,
product?: string | null,
name?: string | null,
description?: string | null,
sku?: string | null,
quantity?: number | null,
term?: string | null,
price?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
discountUnit?: string | null,
discountNumber?: number | null
}[] | null,
subtotalLineItems?: {
id?: string | null,
position?: number | null,
label?: string | null,
modifierUnit?: string | null,
modifierValue?: number | null,
operation?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null
}[] | null,
recipient?: {
id?: string | null,
name?: string | null,
email?: string | null
} | null,
acceptedName?: string | null,
acceptedEmail?: string | null
}& {
number?: string | null,
total?: {
formatted?: string | null,
amount?: string | number | null,
currency?: string | null
} | null,
validThroughTime?: string | null,
createdTime?: string | null,
publishedTime?: string | null,
sentTime?: string | null,
acceptedTime?: string | null,
deletedTime?: string | number | null
}
)[] | null
Sources
create
sources.create
Create a new source
Risk: write
await corsair.nutshell.api.sources.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
sources?: {
name?: string,
channel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
sources | object[] | null | No | — |
sources full type
sources full type
{
id?: string | null,
name?: any | null,
href?: string | null,
modifiedTime?: number | null,
channel?: {
value?: number | null,
display?: string | null
} | null,
deletedTime?: number | null
}[] | null
delete
sources.delete
Delete a Source
Risk: destructive
await corsair.nutshell.api.sources.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
sources | object[] | null | No | — |
sources full type
sources full type
{
id?: string | null,
name?: any | null,
href?: string | null,
modifiedTime?: number | null,
channel?: {
value?: number | null,
display?: string | null
} | null,
deletedTime?: number | null
}[] | null
list
sources.list
Get a list of sources
Risk: read
await corsair.nutshell.api.sources.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
sources | object[] | null | No | — |
sources full type
sources full type
{
id?: string | null,
name?: any | null,
href?: string | null,
modifiedTime?: number | null,
channel?: {
value?: number | null,
display?: string | null
} | null,
deletedTime?: number | null
}[] | null
undelete
sources.undelete
Undelete a Source
Risk: write
await corsair.nutshell.api.sources.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
sources | object[] | null | No | — |
sources full type
sources full type
{
id?: string | null,
name?: any | null,
href?: string | null,
modifiedTime?: number | null,
channel?: {
value?: number | null,
display?: string | null
} | null,
deletedTime?: number | null
}[] | null
Stages
list
stages.list
Get a list of stages
Risk: read
await corsair.nutshell.api.stages.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | Yes | — |
links | object | Yes | — |
stages | object[] | Yes | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}
links full type
links full type
{
}
stages full type
stages full type
{
id: string,
type: stages,
name: string,
description: string,
position: number,
activeAvatarUrl: string,
completeAvatarUrl: string,
incompleteAvatarUrl: string,
overdueAvatarUrl: string,
links: {
stageset: string
}
}[]
Stage Sets
export
stageSets.export
Get a CSV export of lead movements through a pipeline
Risk: read
await corsair.nutshell.api.stageSets.export({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
string
list
stageSets.list
Get a list of pipelines
Risk: read
await corsair.nutshell.api.stageSets.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | Yes | — |
links | object | Yes | — |
stagesets | object[] | Yes | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}
links full type
links full type
{
}
stagesets full type
stagesets full type
(
{
id?: string | null,
name?: any | null,
default?: boolean | null,
canAccess?: boolean | null,
status?: string | number | null
}& {
type: stagesets,
links: {
stages: string[]
}
}
)[]
Tags
create
tags.create
Create a tag
Risk: write
await corsair.nutshell.api.tags.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
tags?: {
name?: string,
colorType?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14,
tagType?: 1 | 2 | 3,
links?: {
entities?: string[]
}
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
tags | object[] | null | No | — |
tags full type
tags full type
{
id?: string | null,
name?: string | null,
href?: string | null,
modifiedTime?: number | null,
deletedTime?: number | null,
tagType?: string | null,
count?: number | null,
colorType?: string | null
}[] | null
delete
tags.delete
Delete a tag
Risk: destructive
await corsair.nutshell.api.tags.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
tags | object[] | null | No | — |
tags full type
tags full type
{
id?: string | null,
name?: string | null,
href?: string | null,
modifiedTime?: number | null,
deletedTime?: number | null,
tagType?: string | null,
count?: number | null,
colorType?: string | null
}[] | null
list
tags.list
Get a list of tags
Risk: read
await corsair.nutshell.api.tags.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
filter[tagType] | leads | contacts | accounts | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
tags | object[] | null | No | — |
tags full type
tags full type
{
id?: string | null,
name?: string | null,
href?: string | null,
modifiedTime?: number | null,
deletedTime?: number | null,
tagType?: string | null,
count?: number | null,
colorType?: string | null
}[] | null
undelete
tags.undelete
Undelete a tag
Risk: write
await corsair.nutshell.api.tags.undelete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
tags | object[] | null | No | — |
tags full type
tags full type
{
id?: string | null,
name?: string | null,
href?: string | null,
modifiedTime?: number | null,
deletedTime?: number | null,
tagType?: string | null,
count?: number | null,
colorType?: string | null
}[] | null
Tasks
create
tasks.create
Create a new task
Risk: write
await corsair.nutshell.api.tasks.create({});
| Name | Type | Required | Description |
|---|---|---|---|
body | object | Yes | — |
body full type
body full type
{
tasks?: {
title?: string,
description?: string,
dueTime?: string,
recurrenceRule?: {
htmlUrl?: string,
htmlUrlPath?: string
}& {
rule?: string,
mode?: dueDate | completion,
id?: string
},
links?: {
relatedEntity?: string,
assignee?: string
}
}[]
}
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
tasks | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
tasks full type
tasks full type
(
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
recurrenceRule?: {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
rule?: string | null,
mode?: string | null,
id?: string | null
} | null
}
)[] | null
delete
tasks.delete
Delete a task
Risk: destructive · Irreversible
await corsair.nutshell.api.tasks.delete({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
recurrenceRule?: {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
rule?: string | null,
mode?: string | null,
id?: string | null
} | null
}
get
tasks.get
Get a task
Risk: read
await corsair.nutshell.api.tasks.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
object
Output full type
Output full type
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
recurrenceRule?: {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
rule?: string | null,
mode?: string | null,
id?: string | null
} | null
}
list
tasks.list
Get a list of tasks
Risk: read
await corsair.nutshell.api.tasks.list({});
| Name | Type | Required | Description |
|---|---|---|---|
q | string | No | — |
filter[assignee] | string[] | No | — |
filter[relatedEntity] | string | No | — |
filter[dateMin] | string | No | — |
filter[dateMax] | string | No | — |
page[limit] | string | No | — |
page[page] | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
tasks | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
tasks full type
tasks full type
(
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
recurrenceRule?: {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
rule?: string | null,
mode?: string | null,
id?: string | null
} | null
}
)[] | null
update
tasks.update
Update a task
Risk: write
await corsair.nutshell.api.tasks.update({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
body | object[] | Yes | — |
body full type
body full type
{
op: add | remove | replace | move | copy,
path: string,
value?: JsonValue
}[]
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
tasks | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
} | null
links full type
links full type
{
} | null
tasks full type
tasks full type
(
{
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
id?: string | null,
recurrenceRule?: {
htmlUrl?: string | null,
htmlUrlPath?: string | null
}& {
rule?: string | null,
mode?: string | null,
id?: string | null
} | null
}
)[] | null
Territories
list
territories.list
Get a list of territories
Risk: read
await corsair.nutshell.api.territories.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
links | object | null | No | — |
territories | object[] | null | No | — |
meta full type
meta full type
{
} | null
links full type
links full type
{
} | null
territories full type
territories full type
{
id?: string | null,
name?: string | null,
href?: string | null,
modifiedTime?: number | null
}[] | null
Todos
list
todos.list
Get tasks and sales process steps
Risk: read
await corsair.nutshell.api.todos.list({});
| Name | Type | Required | Description |
|---|---|---|---|
filter[assignee] | string | No | — |
filter[type] | (tasks | steps | follow-ups | follow-up tasks)[] | No | — |
filter[stagesets] | string[] | No | — |
filter[dueTime] | string | No | — |
filter[dueWindow] | overdue | today | tomorrow | upcoming | No | — |
q | string | No | — |
includeComplete | 0 | 1 | No | — |
onlyComplete | 0 | 1 | No | — |
includeDoneFacet | 0 | 1 | No | — |
onlyDue | 0 | 1 | No | — |
onlyHotLeads | 0 | 1 | No | — |
singleStep | 0 | 1 | No | — |
page[startIndex] | number | No | — |
page[limit] | number | No | — |
page[endIndex] | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
todos | object[] | Yes | — |
relatedEntities | object[] | null | No | — |
users | object[] | null | No | — |
meta | object | Yes | — |
links | object | null | No | — |
todos full type
todos full type
{
id: string,
type: string,
title: string,
description?: string | null,
href?: string | null,
dueTime?: number | null,
completedTime?: number | null,
isCompleted?: boolean | null,
isOverdue?: boolean | null,
isRecurring?: boolean | null,
isSkipped?: boolean | null,
delays?: {
id?: string | null,
name?: string | null,
displayLength?: string | null
}[] | null,
links?: {
} | null
}[]
relatedEntities full type
relatedEntities full type
{
}[] | null
users full type
users full type
{
}[] | null
meta full type
meta full type
{
count: number | null,
facets: {
past: number | null,
today: number | null,
tomorrow: number | null,
future: number | null,
done?: number | null
},
page: {
startIndex: number,
endIndex: number
}
}
links full type
links full type
{
} | null
Users
get
users.get
Get a user
Risk: read
await corsair.nutshell.api.users.get({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
users | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}& {
next?: string | null,
previous?: string | null,
total?: number | null
} | null
users full type
users full type
((
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)& {
avatarUrl?: string | null,
initials?: string | null
})[] | null
list
users.list
Get a list of users
Risk: read
await corsair.nutshell.api.users.list({});
| Name | Type | Required | Description |
|---|---|---|---|
meta | object | null | No | — |
users | object[] | null | No | — |
meta full type
meta full type
{
instanceId?: string | null,
siteId?: string | null
}& {
next?: string | null,
previous?: string | null,
total?: number | null
} | null
users full type
users full type
((
{
avatarUrl?: string | null,
initials?: string | null
}& {
id?: string | null,
name?: any | null,
firstName?: any | null,
modifiedTime?: number | null,
isEnabled?: boolean | null,
hasSetPassword?: boolean | null,
isAdministrator?: boolean | null,
isViewingRestricted?: boolean | null,
isHiddenFromFilters?: boolean | null,
canAccessEmailMarketing?: boolean | null,
permissions?: {
canAccessSetup?: boolean | null,
canAccessMarketing?: boolean | null,
canBulkEdit?: boolean | null,
canExport?: boolean | null,
canViewSharedEmails?: boolean | null,
canImport?: boolean | null,
canMergeEntities?: boolean | null,
canDeleteEntities?: boolean | null,
canAssignEntities?: boolean | null,
canAccessBilling?: boolean | null,
canManageEmailTemplates?: boolean | null,
canAccessCrm?: boolean | null,
canAccessFullCampaigns?: boolean | null,
canUsePeopleIQ?: boolean | null,
canUseInbox?: boolean | null
} | null,
emails?: string[] | null,
phonecallerType?: any | null
}
)& {
avatarUrl?: string | null,
initials?: string | null
})[] | null