Introduction

The Plutio API lets you read and write data in your Plutio workspace from your own code. Use it to automate repetitive work, connect Plutio to other tools, or build your own UI on top of the platform. It works well with tools like N8N, Make (formerly Integromat), and Zapier, as well as custom scripts and backend apps.

All endpoints follow REST conventions and return JSON. You read data with GET, create with POST, update with PUT, and delete with DELETE. HTTP status codes tell you if something went wrong.

A few things worth knowing upfront:

  • Authentication - every request needs an OAuth 2 bearer token in the header. See the Authentication section to get started.
  • Filtering and Search - all GET endpoints support key-value filters and MongoDB-style queries, including text search with $regex. See Filtering and Search.
  • Pagination - use skip and limit to page through results. See Paging.
  • Rate limit - you can make up to 1,000 requests per hour. Going over that returns a 429 error.

Changelog

1 October, 2024

Introduction of new endpoints to support our latest feature updates:

  • Bulk select and edit
  • Archiving
  • Schedulers
  • Transactions

Also in this update, we introduced a way to get invitation URL and remove all items from trash via our API.

Authentication

We use a standard OAuth 2 authentication method.

You can generate an application key and a secret code from your settings page inside the Plutio app and use them to create a temporary access token.

YOUR_PLUTIO_SUBDOMAIN header value should be the first part of your Plutio domain. For example YOUR_PLUTIO_SUBDOMAIN value for https://test.plutio.com would be test.

Visit the "Getting Started" section for more information.

Error Codes

Code

Description

400

Bad request. The server cannot or will not process the request due to an apparent client error (malformed request syntax, invalid params)

401

Unauthorized. Access token is invalid or missing.

403

Forbidden. User is not allowed to perform the action, usually due to permission settings.

404

Not found. The requested resource could not be found.

405

Method not allowed. A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST

429

Too Many Requests. Your API limits have been reached.

500

Internal server error. Server could not process your request due to unexpected condition. Please try again later or if the issue persists please contact us.

Rate limit

You can make up to 1,000 API requests per hour per API key. If you go over that, you will get a 429 Too Many Requests response.

If you hit the limit, wait before retrying. A simple back-off works well: wait 1 second, then 2, then 4, and so on. The limit resets every hour.

Paging

You can use skip and limit query parameters to get a different set of items.https://api.plutio.com/v1.8/tasks?skip=20&limit=50This will return tasks 21..70

Getting started

POST

Generate access token

https://api.plutio.com/v1.11/oauth/token

Creates a new getting-started in your workspace and returns the created record.

Every API request needs an OAuth2 access token in the Authorization header. Use the request below to generate one from your application credentials.

You can find your Client ID and Client Secret in your Plutio app under Settings > API.

The response contains an accessTokenExpiresAt field that tells you when the token expires. When it does, just call this endpoint again to get a new one. Keep your token safe and do not expose it in client-side or public code.

Field
Type
Req
Description
client_id
string
Client ID obtained from settings page
client_secret
string
Client secret obtained from settings page
grant_type
string
Required value 'client_credentials'

Workspace

Your Plutio workspace is the top-level container for everything in your account. Every person, project, invoice, file, conversation, and setting lives inside one workspace. When you make API calls, you are always working within a specific workspace identified by your subdomain. For example if your Plutio URL is acme.plutio.com, your subdomain is "acme" and every request you make is scoped to that workspace only.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
address
object
Physical mailing address.
address.city
string
CityMax: 256
address.country
string
CountryAllowed: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
address.street
string
StreetMax: 256
address.zipCode
string
Zip codeMax: 256
archivedAt
date
When this record was moved to the archive.
color
object
Display color for this record.
color.publicBg
string
Public bg
color.publicButtonBg
string
Public button bg
color.publicButtonText
string
Public button text
color.publicText
string
Public text
colorPalette
object
Set of brand or theme colors associated with this item.
colors
array
Colors used for this record.Max: 10
colors.$
string
Colors
contactEmails
array
Email addresses for this contact.
contactEmails.$
object
Contact emails
contactEmails.$.address
string
Address
contactEmails.$.type
string
TypeAllowed: alternative, email, personal, work
contactPhones
array
Phone numbers for this contact.
contactPhones.$
object
Contact phones
contactPhones.$.number
string
NumberMax: 256
contactPhones.$.type
string
TypeAllowed: fax, mobile, office, personal, phone, work
contracts
object
Contracts linked to this record.
contracts.assignIdForDraft
boolean
Assign ID for draft
contracts.messengerId
string
Messenger ID
contracts.nextId
string
Next ID
contracts.prefix
string
Prefix
contracts.suffix
string
Suffix
conversations
object
Conversations linked to this record.
conversations.nextId
string
Next ID
coupon
string
Discount coupon code applied to this invoice.
createdAt
date
When this record was created.
css
object
Custom CSS settings for this workspace.
css.public
string
PublicMax: 5000
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
customRoles
array
Custom roles configured within this record.
customRoles.$
object
Custom roles
customRoles.$.entityPermissions
object
Entity permissions
customRoles.$.slug
string
Slug
customRoles.$.title
string
Title
dashboards
object
Dashboards linked to this record.
dashboards.messengerId
string
Messenger ID
defaultTemplates
object
Default templates assigned to each resource type in this workspace.
defaultTemplates.contract
string
Contract
defaultTemplates.form
string
Form
defaultTemplates.invoice
string
Invoice
defaultTemplates.project
string
Project
defaultTemplates.proposal
string
Proposal
defaultTemplates.receipt
string
Receipt
defaultViews
object
Default view configurations for each section of this workspace.
domain
string
Custom domain configured for client-facing pages on this workspace.Min: 3Max: 80
entityCounts
object
Count of attached items (tasks, files, etc.) grouped by type.
expiredDetails
object
Information recorded when this record expired.
expiredDetails.reason
string
Reason
forms
object
Forms linked to this record.
forms.nextId
string
Next ID
forms.prefix
string
Prefix
forms.suffix
string
Suffix
invoices
object
Invoices linked to this record.
invoices.assignIdForDraft
boolean
Assign ID for draft
invoices.bank
object
Bank
invoices.bank.banks
array
Banks
invoices.bank.banks.$
object
Banks
invoices.bank.banks.$._id
string
ID
invoices.bank.banks.$.details
array
Details
invoices.bank.banks.$.details.$
object
Details
invoices.bank.banks.$.details.$.key
string
KeyMax: 100
invoices.bank.banks.$.details.$.value
string
ValueMax: 500
invoices.bank.banks.$.isActive
boolean
Is active
invoices.bank.banks.$.title
string
TitleMin: 1Max: 256
invoices.bank.isActive
boolean
Is active
invoices.bank.updatedAt
date
Updated at
invoices.daysDue
number
Days dueMin: 0Max: 365
invoices.defaultMethod
array
Default method
invoices.defaultMethod.$
string
Default method
invoices.isDiscountBeforeTax
boolean
Is discount before tax
invoices.messengerId
string
Messenger ID
invoices.nextId
string
Next ID
invoices.paypal
object
Paypal
invoices.paypal.email
string
Email
invoices.paypal.isActive
boolean
Is active
invoices.paypal.updatedAt
date
Updated at
invoices.prefix
string
Prefix
invoices.shouldSendOverdue
boolean
Should send overdue
invoices.shouldSendReceipt
boolean
Should send receipt
invoices.square
object
Square
invoices.square.currency
string
Currency
invoices.square.isActive
boolean
Is active
invoices.square.locationId
string
Location ID
invoices.square.locations
array
Locations
invoices.square.locations.$
object
Locations
invoices.square.locations.$._id
string
ID
invoices.square.locations.$.currency
string
Currency
invoices.square.locations.$.title
string
Title
invoices.square.merchantId
string
Merchant ID
invoices.square.updatedAt
date
Updated at
invoices.stripe
object
Stripe
invoices.stripe.isActive
boolean
Is active
invoices.stripe.stripeAccountId
string
Stripe account ID
invoices.stripe.updatedAt
date
Updated at
invoices.suffix
string
Suffix
invoices.tax
array
Tax
invoices.tax.$
object
Tax
invoices.tax.$.title
string
TitleMax: 100
invoices.tax.$.value
number
Value
isArchived
boolean
This record has been archived and is hidden from main views.
isBetaActive
boolean
Beta features are enabled for this workspace.
logo
object
Logo image data.
logo.big
object
Big
logo.big._id
string
ID
logo.big.extension
string
Extension
logo.big.group
string
Group
logo.big.handle
string
Handle
logo.big.mimeType
string
Mime typeMax: 256
logo.big.size
number
Size
logo.big.title
string
TitleMin: 1Max: 500
logo.big.url
string
Url
logo.bigAlternate
object
Big alternate
logo.bigAlternate._id
string
ID
logo.bigAlternate.extension
string
Extension
logo.bigAlternate.group
string
Group
logo.bigAlternate.handle
string
Handle
logo.bigAlternate.mimeType
string
Mime typeMax: 256
logo.bigAlternate.size
number
Size
logo.bigAlternate.title
string
TitleMin: 1Max: 500
logo.bigAlternate.url
string
Url
logo.favicon
object
Favicon
logo.favicon._id
string
ID
logo.favicon.extension
string
Extension
logo.favicon.group
string
Group
logo.favicon.handle
string
Handle
logo.favicon.mimeType
string
Mime typeMax: 256
logo.favicon.size
number
Size
logo.favicon.title
string
TitleMin: 1Max: 500
logo.favicon.url
string
Url
logo.public
object
Public
logo.public._id
string
ID
logo.public.extension
string
Extension
logo.public.group
string
Group
logo.public.handle
string
Handle
logo.public.mimeType
string
Mime typeMax: 256
logo.public.size
number
Size
logo.public.title
string
TitleMin: 1Max: 500
logo.public.url
string
Url
logo.square
object
Square
logo.square._id
string
ID
logo.square.extension
string
Extension
logo.square.group
string
Group
logo.square.handle
string
Handle
logo.square.mimeType
string
Mime typeMax: 256
logo.square.size
number
Size
logo.square.title
string
TitleMin: 1Max: 500
logo.square.url
string
Url
logo.squareAlternate
object
Square alternate
logo.squareAlternate._id
string
ID
logo.squareAlternate.extension
string
Extension
logo.squareAlternate.group
string
Group
logo.squareAlternate.handle
string
Handle
logo.squareAlternate.mimeType
string
Mime typeMax: 256
logo.squareAlternate.size
number
Size
logo.squareAlternate.title
string
TitleMin: 1Max: 500
logo.squareAlternate.url
string
Url
meta
object
System metadata for this record.
meta.cover
object
Cover
meta.cover._id
string
ID
meta.cover.extension
string
Extension
meta.cover.group
string
Group
meta.cover.handle
string
Handle
meta.cover.mimeType
string
Mime typeMax: 256
meta.cover.size
number
Size
meta.cover.title
string
TitleMin: 1Max: 500
meta.cover.url
string
Url
meta.description
string
DescriptionMax: 120
meta.title
string
TitleMax: 60
name
string
Display name.Min: 3Max: 256
onboardingInfo
object
Answers collected during workspace setup.
onboardingInfo.currentTools
array
Current tools
onboardingInfo.currentTools.$
string
Current toolsAllowed: andco, asana, basecamp, clickup, dubsado, hats17, hellobonsai, honeybook, keap, monday, notion, other, spreadsheets, stickynotes, teamwork, trello
onboardingInfo.goals
array
Goals
onboardingInfo.goals.$
string
GoalsAllowed: consolidate-apps, save-money, simplify-workflow
onboardingInfo.hasTeam
boolean
Has team
onboardingInfo.hearedFrom
array
Heared from
onboardingInfo.hearedFrom.$
string
Heared fromAllowed: ads, blog, email, facebook, forum, friend, google, instagram, linkedin, other-social, pinterest, radio, search-engine, tiktok, tv, twitter, youtube
onboardingInfo.teamSize
string
Team sizeAllowed: 10-20, 100+, 2-5, 20-50, 5-10, 50-100, 500+
onboardingInfo.workTypes
array
Work types
onboardingInfo.workTypes.$
string
Work typesAllowed: apparel-and-fashion, arts-and-crafts, coaching-and-training, computer-games, digital-marketing, events-and-entertainment, finance-and-accounting, graphic-design, health-care-provider, music-and-audio, other, photography, programming-and-tech, realestate-and-construction, video-and-animation, writing-and-translation
ownerInactivityWarning
object
Warning state shown when the workspace owner has been inactive too long.
ownerInactivityWarning.archivalProcessStartsAt
date
Archival process starts at
ownerInactivityWarning.createdAt
date
Created at
permissions
object
Access control settings for this record.
proposals
object
Proposals linked to this record.
proposals.assignIdForDraft
boolean
Assign ID for draft
proposals.autoInvoiceTemplateId
string
Auto invoice template ID
proposals.messengerId
string
Messenger ID
proposals.nextId
string
Next ID
proposals.prefix
string
Prefix
proposals.suffix
string
Suffix
receipts
object
Receipt settings for this workspace.
receipts.workspaceSubscriptionHeader
string
Workspace subscription headerMax: 2000
removalConfirmationCode
string
One-time code required to permanently delete this workspace.Min: 30Max: 30
rolesUsage
object
Which roles workspace members currently hold.
scheduler
object
Booking page settings for this workspace.
scheduler.assignIdForDraft
boolean
Assign ID for draft
scheduler.messengerId
string
Messenger ID
scheduler.nextId
string
Next ID
scheduler.prefix
string
Prefix
scheduler.suffix
string
Suffix
settings
object
Configuration settings for this workspace.
settings.comment
object
Comment
settings.comment.isReactionsEnabled
boolean
Is reactions enabled
settings.comment.reactions
array
Reactions
settings.comment.reactions.$
object
Reactions
settings.comment.reactions.$.reaction
string
Reaction
settings.general
object
General
settings.general.defaultMessages
object
Default messages
settings.general.defaultMessages.contractEmail
string
Contract emailMax: 10000
settings.general.defaultMessages.invitation
string
InvitationMax: 10000
settings.general.defaultMessages.invoiceEmail
string
Invoice emailMax: 10000
settings.general.defaultMessages.proposalEmail
string
Proposal emailMax: 10000
settings.general.defaultMessages.receiptEmail
string
Receipt emailMax: 10000
settings.general.iframe
object
Iframe
settings.general.iframe.isEnabled
boolean
Is enabled
settings.general.isContractsEnabled
boolean
Is contracts enabled
settings.general.isFormsEnabled
boolean
Is forms enabled
settings.general.isInboxEnabled
boolean
Is inbox enabled
settings.general.isInvoicingEnabled
boolean
Is invoicing enabled
settings.general.isProposalsEnabled
boolean
Is proposals enabled
settings.general.isSchedulerEnabled
boolean
Is scheduler enabled
settings.general.isTimeTrackEnabled
boolean
Is time track enabled
settings.general.isWikiEnabled
boolean
Is wiki enabled
settings.general.registrations
object
Registrations
settings.general.registrations.defaultRole
string
Default role
settings.general.registrations.type
string
TypeAllowed: invite, open
settings.general.registrations.whitelistedEmails
array
Whitelisted emails
settings.general.registrations.whitelistedEmails.$
string
Whitelisted emailsMax: 200
settings.general.useLegacyBlockEditor
boolean
Use legacy block editor
settings.locale
object
Locale
settings.locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
settings.locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
settings.locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
settings.locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
settings.locale.timestampFormat
string
Timestamp formatAllowed: absolute, both, relative
settings.locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
settings.locale.weekStartDay
string
Week start dayAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
settings.mainMenu
object
Main menu
settings.task
object
Task
settings.task.newTaskTop
boolean
New task top
settings.timeTracking
object
Time tracking
settings.timeTracking.categories
array
CategoriesMax: 10
settings.timeTracking.categories.$
object
Categories
settings.timeTracking.categories.$._id
string
ID
settings.timeTracking.categories.$.billingRate
number
Billing rateMin: 0
settings.timeTracking.categories.$.costRate
number
Cost rateMin: 0
settings.timeTracking.categories.$.title
string
TitleMax: 255
sso
object
Single sign-on configuration for this workspace.
sso.auth0
object
Auth0
sso.auth0.clientId
string
Client IDMin: 1Max: 200
sso.auth0.domain
string
DomainMin: 1Max: 200
sso.auth0.isActive
boolean
Is active
status
string
Current status of this record. Values vary by resource.Allowed: active, archived, expired
subscription
object
The Plutio billing subscription for this workspace.
subscription.addons
object
Addons
subscription.addons.contributor
object
Contributor
subscription.addons.contributor.quantity
number
Quantity
subscription.addons.contributor.subscriptionId
string
Subscription ID
subscription.addons.fileUploadSize
object
File upload size
subscription.addons.fileUploadSize.quantity
number
Quantity
subscription.addons.fileUploadSize.subscriptionId
string
Subscription ID
subscription.addons.sso
object
Sso
subscription.addons.sso.quantity
number
Quantity
subscription.addons.sso.subscriptionId
string
Subscription ID
subscription.addons.status
string
StatusAllowed: active, expired, incomplete, none, past_due, trial
subscription.addons.subscriptionId
string
Subscription ID
subscription.addons.whitelabel
object
Whitelabel
subscription.addons.whitelabel.quantity
number
Quantity
subscription.addons.whitelabel.subscriptionId
string
Subscription ID
subscription.balance
number
Balance
subscription.cancelAtPeriodEnd
boolean
Cancel at period end
subscription.currency
string
Currency
subscription.discount
object
Discount
subscription.discount.amountOff
number
Amount off
subscription.discount.code
string
Code
subscription.discount.percentOff
number
Percent off
subscription.expiresAt
date
Expires at
subscription.id
string
ID
subscription.isTrialExtensionUsed
boolean
Is trial extension used
subscription.log
array
Log
subscription.log.$
object
Log
subscription.nextBillingDate
date
Next billing date
subscription.paymentMethod
object
Payment method
subscription.paymentMethod._id
string
ID
subscription.paymentMethod.customerId
string
Customer ID
subscription.paymentMethod.meta
object
Meta
subscription.paymentMethod.meta.cardExpMonth
number
Card exp month
subscription.paymentMethod.meta.cardExpYear
number
Card exp year
subscription.paymentMethod.meta.cardLast4
string
Card last4
subscription.paymentMethod.meta.cardType
string
Card type
subscription.plan
object
Plan
subscription.plan.addons
object
Addons
subscription.plan.addons.contributor
number
ContributorMin: 0
subscription.plan.addons.fileUploadSize
boolean
File upload size
subscription.plan.addons.sso
boolean
Sso
subscription.plan.addons.whitelabel
boolean
Whitelabel
subscription.plan.allowances
object
Allowances
subscription.plan.allowances.client
number
Client
subscription.plan.allowances.contributor
number
Contributor
subscription.plan.allowances.fileUploadSize
boolean
File upload size
subscription.plan.allowances.sso
boolean
Sso
subscription.plan.allowances.whitelabel
boolean
Whitelabel
subscription.plan.customAddons
object
Custom addons
subscription.plan.customAddons.contributor
number
ContributorMin: 0
subscription.plan.customAddons.fileUploadSize
boolean
File upload size
subscription.plan.customAddons.sso
boolean
Sso
subscription.plan.customAddons.whitelabel
boolean
Whitelabel
subscription.plan.id
string
ID
subscription.plan.isCampaign
boolean
Is campaign
subscription.plan.isCustom
boolean
Is custom
subscription.plan.limits
object
Limits
subscription.plan.limits.contributor
number
Contributor
subscription.plan.limits.sso
boolean
Sso
subscription.plan.type
string
TypeAllowed: AppSumo, AppSumo2021, AppSumoBlackFriday, AppSumoExclusiveTeam, AppSumoStacked, StackCommerce, agency, solo, solo_new, studio, studio_new, team, trial
subscription.price
number
Price
subscription.status
string
StatusAllowed: active, expired, incomplete, none, past_due, trial
subscription.subscribedAt
date
Subscribed at
subscription.tax
number
Tax
subscription.type
string
TypeAllowed: lifetime, limited-time, monthly, yearly
tasks
object
Tasks linked to this record.
tasks.nextId
string
Next ID
transactions
object
Payment transaction settings for this workspace.
transactions.assignIdForDraft
boolean
Assign ID for draft
transactions.nextId
string
Next ID
transactions.prefix
string
Prefix
transactions.suffix
string
Suffix
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
whitelabel
object
White-label settings that hide Plutio branding on client-facing pages.
whitelabel.domain
string
Domain
whitelabel.isActive
boolean
Is active
whitelabel.mail
object
Mail
whitelabel.mail.address
string
Address
whitelabel.mail.host
string
Host
whitelabel.mail.isActive
boolean
Is active
whitelabel.mail.name
string
NameMax: 150
whitelabel.mail.password
string
Password
whitelabel.mail.port
number
PortMin: 0Max: 65535
whitelabel.mail.replyToNotificationDomain
string
Reply to notification domain
whitelabel.mail.service
string
ServiceAllowed: 126, 163, 1und1, AOL, Bluewin, DebugMail, DynectEmail, Ethereal, FastMail, GandiMail, Gmail, Godaddy, GodaddyAsia, GodaddyEurope, Hotmail, Infomaniak, Mail.ru, Maildev, Mailgun, Mailjet, Mailosaur, Mailtrap, Mandrill, Naver, OhMySMTP, One, OpenMailBox, Outlook365, Postmark, QQ, QQex, SES, SES-EU-WEST-1, SES-US-EAST-1, SES-US-WEST-2, SendCloud, SendGrid, SendPulse, SendinBlue, Sparkpost, Tipimail, Yahoo, Yandex, Zoho, hot.ee, iCloud, mail.ee, qiye.aliyun
whitelabel.mail.useSSL
boolean
Use ssl
whitelabel.mail.username
string
Username
workingHours
array
The workspace's configured working days and hours.Min: 7Max: 7
workingHours.$
object
Working hours
workingHours.$.endTime
string
End time
workingHours.$.isActive
boolean
Is active
workingHours.$.startTime
string
Start time
PUT

Update workspace

https://api.plutio.com/v1.11/businesses

Updates your workspace settings such as name, branding, and preferences.

No required fields for this request. Any fields from the schema above are accepted.

GET

Get workspace

https://api.plutio.com/v1.11/businesses

Returns the current settings and details for your workspace.

Custom Fields

Custom fields let you add your own structured data to any resource in Plutio. For example you might add a "Budget" number field to projects, a "Contract Value" field to proposals, or a "Priority Level" dropdown to tasks. You define the field once and it appears on every record of that type across your workspace. Use them to capture information that Plutio does not store by default.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
allowCreate
boolean
Whether new items can be created inside this container.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
displayTime
boolean
Whether to show time alongside the date for this custom field.
entityType
string
Resource type this item is attached to.Allowed: business, company, contract, conversation, file, form, invoice, invoice-subscription, person, project, proposal, scheduler, task, transaction
inputType
string
The input type for this custom field: text, link, slider, multirange, currency, checkbox, rating, select, multi, contact, or date.Allowed: checkbox, contact, currency, date, link, multi, multirange, rating, select, slider, text
isAddedByDefault
boolean
Automatically include this item when creating new records.
isArchived
boolean
This record has been archived and is hidden from main views.
max
number
Maximum allowed value.
min
number
Minimum allowed value.
options
array
Selectable choices for this custom field. Used with dropdown and multi-select field types.
options.$
object
Options
options.$._id
string
ID
options.$.color
string
Color
options.$.index
number
Index
options.$.name
string
Name
options.$.textColor
string
Text color
permissions
object
Access control settings for this record.
ratingEmoji
string
Emoji set used for the rating scale on this form field.
ratingSize
number
Number of rating options (e.g. 5 for a 5-star rating).Allowed: 2, 3, 4, 5, 6
roles
array
Roles available or assigned in this context.
roles.$
string
Roles
showCompanies
boolean
Show companies in this contact-type custom field.
step
number
The increment step for this numeric custom field. Controls how the value changes in slider and currency inputs.Min: 0.01
title
string
Display name for this record.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create custom field

https://api.plutio.com/v1.11/custom-fields

Creates a new custom field in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityType
string
Resource type this item is attached to.Allowed: business, company, contract, conversation, file, form, invoice, invoice-subscription, person, project, proposal, scheduler, task, transaction
title
string
Display name for this record.
PUT

Update custom field

https://api.plutio.com/v1.11/custom-fields

Updates the fields of an existing custom field. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get custom field

https://api.plutio.com/v1.11/custom-fields

Returns a list of all custom fields in your workspace.

DELETE

Delete custom field

https://api.plutio.com/v1.11/custom-fields

Permanently deletes this custom field from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

People

People are the contacts you track inside Plutio. This includes your clients, leads, freelancers, vendors, and anyone else you interact with professionally. Each person has basic contact info like name, email, and phone number and you can link them to companies, projects, invoices, and conversations. When you create an invoice for a client or send a message to someone, you are referencing a person record.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
address
object
Physical mailing address.
address.city
string
CityMax: 256
address.country
string
CountryAllowed: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
address.street
string
StreetMax: 256
address.zipCode
string
Zip codeMax: 256
avatar
object
Profile picture data.
avatar._id
string
ID
avatar.extension
string
Extension
avatar.group
string
Group
avatar.handle
string
Handle
avatar.mimeType
string
Mime typeMax: 256
avatar.size
number
Size
avatar.title
string
TitleMin: 1Max: 500
avatar.url
string
Url
badgeCounts
object
Unread counts for notifications shown as badges in the UI.
badgeCounts.conversation
array
Conversation
badgeCounts.conversation.$
object
Conversation
badgeCounts.conversation.$._id
string
ID
badgeCounts.conversation.$.count
integer
CountMin: 0
badgeCounts.conversation.$.entityId
string
Entity ID
badgeCounts.conversation.$.entityType
string
Entity type
badgeCounts.conversation.$.group
string
Group
badgeCounts.conversation.$.isSilent
boolean
Is silent
badgeCounts.notification
integer
NotificationMin: 0
badgeCounts.refreshedAt
date
Refreshed at
bioHTML
string
Profile biography as formatted HTML.
bioPlain
string
Profile biography as plain text.Max: 10000
birthDay
date
Date of birth.
businessId
string
ID of the workspace this record belongs to.
cache
object
Cached computed values for this record.
cache.visibleInboxGroups
array
Visible inbox groups
cache.visibleInboxGroups.$
string
Visible inbox groups
color
string
Display color for this record.
companies
array
Companies linked to this record.
companies.$
object
Companies
companies.$._id
string
ID
companies.$.entityPermissions
array
Entity permissions
companies.$.entityPermissions.$
string
Entity permissionsAllowed: contract, invoice, invoice-subscription, proposal
companies.$.isManager
boolean
Is manager
companies.$.role
string
RoleMax: 256
contactEmails
array
Email addresses for this contact.
contactEmails.$
object
Contact emails
contactEmails.$.address
string
Address
contactEmails.$.type
string
TypeAllowed: alternative, email, personal, work
contactPhones
array
Phone numbers for this contact.
contactPhones.$
object
Contact phones
contactPhones.$.number
string
NumberMax: 256
contactPhones.$.type
string
TypeAllowed: fax, mobile, office, personal, phone, work
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
deletedAt
date
When this record was deleted.
dismissedNotifications
array
IDs of notifications this user has dismissed.Max: 100
dismissedNotifications.$
object
Dismissed notifications
dismissedNotifications.$.createdAt
date
Created at
dismissedNotifications.$.expiresAt
date
Expires at
dismissedNotifications.$.id
string
ID
favoriteLinks
array
Quick-access links bookmarked by this user.
favoriteLinks.$
object
Favorite links
favoriteLinks.$.icon
string
Icon
favoriteLinks.$.link
string
LinkMax: 200
favoriteLinks.$.linkId
string
Link ID
favoriteLinks.$.title
string
TitleMax: 100
hasBio
boolean
True if a bio has been written on this profile.
invitedBy
object
Details of whoever sent the workspace invitation.
invitedBy._id
string
ID
invitedBy.name
string
Name
isArchived
boolean
This record has been archived and is hidden from main views.
isOnboarded
boolean
This profile has completed the workspace onboarding.
lastLogin
date
When this profile last logged into the workspace.
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timestampFormat
string
Timestamp formatAllowed: absolute, both, relative
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
locale.weekStartDay
string
Week start dayAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
name
object
Display name.
name.first
string
FirstMin: 1Max: 30
name.last
string
LastMax: 50
nameSortKey
string
Lowercase normalized version of name used for sorting.
permissions
object
Access control settings for this record.
preferences
object
User or workspace preferences.
preferences.calendar
object
Calendar
preferences.calendar.isSyncing
date
Is syncing
preferences.calendar.lastSyncFinishedAt
date
Last sync finished at
preferences.calendar.lastSyncStartedAt
date
Last sync started at
preferences.cardViewCols
object
Card view cols
preferences.closedGroups
object
Closed groups
preferences.closedGroups.task-group
array
Task group
preferences.closedGroups.task-group.$
string
Task group
preferences.colViewCols
object
Col view cols
preferences.filterOptions
object
Filter options
preferences.filters
object
Filters
preferences.general
object
General
preferences.general.cssMode
string
Css modeAllowed: dark, default
preferences.inboxAppearance
string
Inbox appearanceAllowed: bubbly, compact, cosy
preferences.integrations
object
Integrations
preferences.integrations.google
object
Google
preferences.integrations.google-meet
object
Google meet
preferences.integrations.google-meet.isActive
boolean
Is active
preferences.integrations.google-meet.updatedAt
date
Updated at
preferences.integrations.google.calendars
array
Calendars
preferences.integrations.google.calendars.$
object
Calendars
preferences.integrations.google.calendars.$._id
string
ID
preferences.integrations.google.calendars.$.canWrite
boolean
Can write
preferences.integrations.google.calendars.$.color
string
Color
preferences.integrations.google.calendars.$.isActive
boolean
Is active
preferences.integrations.google.calendars.$.isPrimary
boolean
Is primary
preferences.integrations.google.calendars.$.lastSyncFinishedAt
date
Last sync finished at
preferences.integrations.google.calendars.$.lastSyncStartedAt
date
Last sync started at
preferences.integrations.google.calendars.$.nextPageToken
string
Next page token
preferences.integrations.google.calendars.$.nextSyncToken
string
Next sync token
preferences.integrations.google.calendars.$.title
string
Title
preferences.integrations.google.isActive
boolean
Is active
preferences.integrations.google.isSyncing
boolean
Is syncing
preferences.integrations.google.lastSyncFinishedAt
date
Last sync finished at
preferences.integrations.google.lastSyncStartedAt
date
Last sync started at
preferences.integrations.google.updatedAt
date
Updated at
preferences.integrations.zoom
object
Zoom
preferences.integrations.zoom.isActive
boolean
Is active
preferences.integrations.zoom.updatedAt
date
Updated at
preferences.listViewCols
object
List view cols
preferences.notifications
object
Notifications
preferences.notifications.chat
object
Chat
preferences.notifications.chat.newDM
boolean
New dm
preferences.notifications.contract
object
Contract
preferences.notifications.contract.signed
boolean
Signed
preferences.notifications.contract.viewed
boolean
Viewed
preferences.notifications.conversation
object
Conversation
preferences.notifications.conversation.added_to_conversation
boolean
Added to conversation
preferences.notifications.conversation.new_reply
boolean
New reply
preferences.notifications.desktop_push_enabled
boolean
Desktop push enabled
preferences.notifications.digest
object
Digest
preferences.notifications.digest.enabled
boolean
Enabled
preferences.notifications.digest.time
number
TimeAllowed: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 3, 4, 5, 6, 7, 8, 9
preferences.notifications.email_enabled
boolean
Email enabled
preferences.notifications.external
object
External
preferences.notifications.external.general
boolean
General
preferences.notifications.external.marketing
boolean
Marketing
preferences.notifications.external.newsletter
boolean
Newsletter
preferences.notifications.external.onboarding
boolean
Onboarding
preferences.notifications.form
object
Form
preferences.notifications.form.submitted
boolean
Submitted
preferences.notifications.form.viewed
boolean
Viewed
preferences.notifications.inbox
object
Inbox
preferences.notifications.inbox.newEmail
boolean
New email
preferences.notifications.invoice
object
Invoice
preferences.notifications.invoice.paid
boolean
Paid
preferences.notifications.invoice.viewed
boolean
Viewed
preferences.notifications.mobile_push_enabled
boolean
Mobile push enabled
preferences.notifications.people
object
People
preferences.notifications.people.inviteByMeAccepted
boolean
Invite by me accepted
preferences.notifications.people.inviteByOthersAccepted
boolean
Invite by others accepted
preferences.notifications.project
object
Project
preferences.notifications.project.added_to_project
boolean
Added to project
preferences.notifications.project.new_file
boolean
New file
preferences.notifications.proposal
object
Proposal
preferences.notifications.proposal.signed
boolean
Signed
preferences.notifications.proposal.viewed
boolean
Viewed
preferences.notifications.reminders
boolean
Reminders
preferences.notifications.send_email_when
string
Send email whenAllowed: always, offline
preferences.notifications.task
object
Task
preferences.notifications.task.assignedToMe
boolean
Assigned to me
preferences.notifications.task.createdByEmail
boolean
Created by email
preferences.notifications.task.dateOnlyReminderTime
number
Date only reminder timeAllowed: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 3, 4, 5, 6, 7, 8, 9
preferences.notifications.task.delegatedCompleted
boolean
Delegated completed
preferences.notifications.task.mentionedComment
boolean
Mentioned comment
preferences.notifications.task.mentionedDesc
boolean
Mentioned desc
preferences.notifications.task.newComment
boolean
New comment
preferences.notifications.task.remindTime
number
Remind timeAllowed: 0, 10, 120, 20, 30, 300, 5, 60
preferences.notifications.web_push_enabled
boolean
Web push enabled
preferences.pinnedConversations
array
Pinned conversations
preferences.pinnedConversations.$
object
Pinned conversations
preferences.pinnedConversations.$._id
string
ID
preferences.sendCommentTrigger
string
Send comment triggerAllowed: cmdenter, enter, send, shiftenter
preferences.sendMessageTrigger
string
Send message triggerAllowed: cmdenter, enter, send, shiftenter
preferences.tableViewCols
object
Table view cols
preferences.task
object
Task
preferences.task.follower
string
FollowerAllowed: all, default, owned
preferences.task.pageView
string
Page viewAllowed: sections, tabs
preferences.task.previewPosition
string
Preview positionAllowed: left, popup, right
preferences.views
object
Views
preferences.views.calendar
string
CalendarAllowed: agenda, day, month, week, year
preferences.views.companies
string
CompaniesAllowed: cards, table
preferences.views.contracts
string
ContractsAllowed: cards, table, timeline
preferences.views.email
string
EmailAllowed: default, recipient
preferences.views.files
string
FilesAllowed: cards, table
preferences.views.forms
string
FormsAllowed: cards, table
preferences.views.invoice_subscriptions
string
Invoice subscriptionsAllowed: cards, table
preferences.views.invoices
string
InvoicesAllowed: cards, table, timeline
preferences.views.main_tasks
string
Main tasksAllowed: calendar, table, timeline
preferences.views.people
string
PeopleAllowed: cards, table
preferences.views.projects
string
ProjectsAllowed: cards, table, timeline
preferences.views.proposals
string
ProposalsAllowed: cards, table, timeline
preferences.views.scheduler
string
SchedulerAllowed: cards, table
preferences.views.task_boards
string
Task boardsAllowed: calendar, list, table, timeline
preferences.views.tasks
string
TasksAllowed: calendar, cols, list, table, timeline
preferences.views.timeline
object
Timeline
preferences.views.timeline.invoice
string
InvoiceAllowed: agenda, day, month, week, year
preferences.views.timeline.project
string
ProjectAllowed: agenda, day, month, week, year
preferences.views.timeline.proposal
string
ProposalAllowed: agenda, day, month, week, year
preferences.views.timeline.task
string
TaskAllowed: agenda, day, month, week, year
preferences.views.transactions
string
TransactionsAllowed: cards, table
preferences.widths
object
Widths
preferences.wiki
object
Wiki
preferences.wiki.showProjectWikis
boolean
Show project wikis
role
string
Role assigned to this profile.
squareCustomerId
string
This client's ID in Square for payment processing.
status
string
Current status of this record. Values vary by resource.Allowed: active, archived, deleted, inactive, pending
stripeCustomerId
string
This client's ID in Stripe for payment processing.
timeTracking
object
Time tracking settings for this person.
timeTracking.billingRate
number
Billing rateMin: 0
timeTracking.categories
array
CategoriesMax: 10
timeTracking.categories.$
object
Categories
timeTracking.categories.$._id
string
ID
timeTracking.categories.$.billingRate
number
Billing rateMin: 0
timeTracking.categories.$.costRate
number
Cost rateMin: 0
timeTracking.categories.$.title
string
TitleMax: 255
timeTracking.costRate
number
Cost rateMin: 0
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
unusedInvitationSentAt
date
When a workspace invite was sent that has not been accepted yet.
unusedInvitationSentTo
string
Email the pending workspace invite was sent to.
updatedAt
date
When this record was last modified.
userId
string
Profile ID of the associated user.
websiteLinks
array
Website URLs for this person or company.
websiteLinks.$
object
Website links
websiteLinks.$.title
string
TitleMax: 256
websiteLinks.$.type
string
Type
websiteLinks.$.url
string
Url
POST

Create person

https://api.plutio.com/v1.11/people

Creates a new person in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
name
object
Display name.
name.first
string
FirstMin: 1Max: 30
role
string
Role assigned to this profile.
POST

Archive person

https://api.plutio.com/v1.11/people/archive

Archives this person, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive person

https://api.plutio.com/v1.11/people/bulk/archive

Archives multiple people in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update person

https://api.plutio.com/v1.11/people

Updates the fields of an existing person. Only the fields you include in the body are changed; everything else stays the same.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Bulk update person

https://api.plutio.com/v1.11/people/bulk

Updates multiple people in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get person

https://api.plutio.com/v1.11/people

Returns a list of all people in your workspace.

GET

Get invitation code of person

https://api.plutio.com/v1.11/people/invitation-code

Returns the unique invitation link for this person so they can join your workspace.

DELETE

Delete person

https://api.plutio.com/v1.11/people

Permanently deletes this person from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete person

https://api.plutio.com/v1.11/people/bulk

Permanently deletes multiple people in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Companies

A company is an organization that your contacts belong to. For example you might have a contact "Sarah Lee" who works at "Bright Agency". By linking Sarah to the Bright Agency company record you can view all projects, invoices, conversations, and activity associated with Bright Agency as a whole. Useful when you work with multiple people from the same organization and want to track the relationship at the company level.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
address
object
Physical mailing address.
address.city
string
CityMax: 256
address.country
string
CountryAllowed: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
address.street
string
StreetMax: 256
address.zipCode
string
Zip codeMax: 256
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
contactEmails
array
Email addresses for this contact.
contactEmails.$
object
Contact emails
contactEmails.$.address
string
Address
contactEmails.$.type
string
TypeAllowed: alternative, email, personal, work
contactPhones
array
Phone numbers for this contact.
contactPhones.$
object
Contact phones
contactPhones.$.number
string
NumberMax: 256
contactPhones.$.type
string
TypeAllowed: fax, mobile, office, personal, phone, work
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 2000
hasDescription
boolean
True if a description has been set.
industry
string
Industry or sector for this company or person.Allowed: accounting, airlines-aviation, alternative-dispute-resolution, alternative-medicine, animation, apparel-fashion, architecture-planning, arts-and-crafts, automotive, aviation-aerospace, banking, biotechnology, broadcast-media, building-materials, business-supplies-and-equipment, capital-markets, chemicals, civic-social-organization, civil-engineering, commercial-real-estate, computer-games, computer-hardware, computer-network-security, computer-networking, computer-software, construction, consumer-electronics, consumer-goods, consumer-services, cosmetics, dairy, defense-space, design, e-commerce, e-learning, education-management, electrical-electronic-manufacturing, entertainment, environmental-services, events-services, executive-office, facilities-services, farming, financial-services, fine-art, fishery, food-beverages, food-production, fund-raising, furniture, gambling-casinos, glass-ceramics-concrete, government-administration, government-relations, graphic-design, health-wellness-and-fitness, higher-education, hospital-health-care, hospitality, human-resources, import-and-export, individual-family-services, industrial-automation, information-services, information-technology-and-services, insurance, international-affairs, international-trade-and-development, internet, investment-banking, investment-management, judiciary, law-enforcement, law-practice, legal-services, legislative-office, leisure-travel-tourism, libraries, logistics-and-supply-chain, luxury-goods-jewelry, machinery, management-consulting, maritime, market-research, marketing-and-advertising, marketplace, mechanical-or-industrial-engineering, media-production, medical-devices, medical-practice, mental-health-care, military, mining-metals, motion-pictures-and-film, museums-and-institutions, music, nanotechnology, newspapers, nonprofit-organization-management, oil-energy, online-media, outsourcing-offshoring, package-freight-delivery, packaging-and-containers, paper-forest-products, performing-arts, pharmaceuticals, philanthropy, photography, plastics, political-organization, primary-secondary-education, printing, professional-training-coaching, program-development, public-policy, public-relations-and-communications, public-safety, publishing, railroad-manufacture, ranching, real-estate, recreational-facilities-and-services, religious-institutions, renewables-environment, research, restaurants, retail, security-and-investigations, semiconductors, shipbuilding, sporting-goods, sports, staffing-and-recruiting, supermarkets, telecommunications, textiles, think-tanks, tobacco, translation-and-localization, transportation-trucking-railroad, utilities, venture-capital-private-equity, veterinary, warehousing, wholesale, wine-and-spirits, wireless, writing-and-editing
isArchived
boolean
This record has been archived and is hidden from main views.
logo
object
Logo image data.
logo._id
string
ID
logo.extension
string
Extension
logo.group
string
Group
logo.handle
string
Handle
logo.mimeType
string
Mime typeMax: 256
logo.size
number
Size
logo.title
string
TitleMin: 1Max: 500
logo.url
string
Url
people
array
People linked to this record.
people.$
object
People
people.$._id
string
ID
people.$.entityPermissions
array
Entity permissions
people.$.entityPermissions.$
string
Entity permissionsAllowed: contract, invoice, invoice-subscription, proposal
people.$.isManager
boolean
Is manager
people.$.role
string
RoleMax: 256
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
websiteLinks
array
Website URLs for this person or company.
websiteLinks.$
object
Website links
websiteLinks.$.title
string
TitleMax: 256
websiteLinks.$.type
string
Type
websiteLinks.$.url
string
Url
POST

Create company

https://api.plutio.com/v1.11/companies

Creates a new company in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1Max: 500
PUT

Update company

https://api.plutio.com/v1.11/companies

Updates the fields of an existing company. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update company

https://api.plutio.com/v1.11/companies/bulk

Updates multiple companies in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get company

https://api.plutio.com/v1.11/companies

Returns a list of all companies in your workspace.

DELETE

Delete company

https://api.plutio.com/v1.11/companies

Permanently deletes this company from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete company

https://api.plutio.com/v1.11/companies/bulk

Permanently deletes multiple companies in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Profiles

A profile is the account record for someone who actually has login access to your Plutio workspace. Every team member and every client you invite to Plutio gets a profile. The profile stores their display name, avatar, language preference, notification settings, and login credentials. Unlike a person record which is just a contact, a profile means someone can actually log in and use Plutio directly.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
address
object
Physical mailing address.
address.city
string
CityMax: 256
address.country
string
CountryAllowed: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
address.street
string
StreetMax: 256
address.zipCode
string
Zip codeMax: 256
avatar
object
Profile picture data.
avatar._id
string
ID
avatar.extension
string
Extension
avatar.group
string
Group
avatar.handle
string
Handle
avatar.mimeType
string
Mime typeMax: 256
avatar.size
number
Size
avatar.title
string
TitleMin: 1Max: 500
avatar.url
string
Url
birthDay
date
Date of birth.
businessId
string
ID of the workspace this record belongs to.
contactEmails
array
Email addresses for this contact.
contactEmails.$
object
Contact emails
contactEmails.$.address
string
Address
contactEmails.$.type
string
TypeAllowed: alternative, email, personal, work
contactPhones
array
Phone numbers for this contact.
contactPhones.$
object
Contact phones
contactPhones.$.number
string
NumberMax: 256
contactPhones.$.type
string
TypeAllowed: fax, mobile, office, personal, phone, work
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
customData
array
Extra key-value data you can attach to extend this record.
customData.$
object
Custom data
customData.$.key
string
KeyMin: 1Max: 200
customData.$.value
number
Value
customData.$.value.$
number
Value
isArchived
boolean
This record has been archived and is hidden from main views.
locale
object
Language code (e.g. en, fr, de, es).
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
name
object
Display name.
name.first
string
FirstMin: 1Max: 30
name.last
string
LastMax: 50
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
uniqueId
string
Secondary unique identifier for external system references.Min: 1Max: 100
updatedAt
date
When this record was last modified.
GET

Get profile

https://api.plutio.com/v1.11/profiles

Returns a list of all profiles that have login access to your workspace, including team members and clients.

Roles

Roles control what people with access to your workspace are allowed to see and do. You define a role once, for example "Client", "Project Manager", or "Contractor", and then assign it to profiles. The role determines whether someone can view invoices, edit projects, manage team members, or access billing. Clients only see their own data and team members get exactly the right level of access.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
isArchived
boolean
This record has been archived and is hidden from main views.
permissions
array
Access control settings for this record.
permissions.$
string
PermissionsAllowed: activities.view_page, archive.edit, archive.view, canned_response.create, canned_response.create_category, canned_response.edit, canned_response.edit_category, company.create, company.delete, company.edit, company.view, company.view_details, contract.create, contract.delete, contract.edit, contract.email, contract.update_status, contract.view, conversation.create, conversation.delete, conversation.edit, conversation.view, customfield.create, customfield.edit, file-folder.create, file-folder.delete, file-folder.edit, file-folder.view, file.comment, file.delete, file.edit, file.upload, file.view, form.create, form.delete, form.edit, form.update_status, form.view, inbox.direct_create, inbox.group_create, invoice.create, invoice.delete, invoice.edit, invoice.email, invoice.update_status, invoice.view, invoice_subscription.create, invoice_subscription.delete, invoice_subscription.edit, invoice_subscription.email, invoice_subscription.view, people.add, people.delete, people.edit, people.invite, people.view_details, people.view_profile, project.create, project.delete, project.edit, project.edit_contributors, project.edit_permissions, project.edit_status, project.move_boards, project.view, project.view_budget, project.view_contributors, proposal.create, proposal.delete, proposal.edit, proposal.email, proposal.update_status, proposal.view, scheduler.create, scheduler.delete, scheduler.edit, scheduler.view, task.complete, task.create, task.delegate, task.delete, task.edit, task.view, task.view_comments, task_board.create, task_board.delete, task_board.edit, task_board.edit_permissions, task_board.move_groups, task_board.view, task_group.create, task_group.delete, task_group.edit, task_group.edit_permissions, task_group.move_tasks, task_group.view, template.create, template.delete, template.edit, template.view, template.view_public, time_track.create, time_track.delete, time_track.edit, time_track.view, time_track.view_billing, time_track.view_cost, time_track.view_tracked_by, transaction.create, transaction.delete, transaction.edit, transaction.view, trash-bin.edit, trash-bin.view, wiki.create, wiki.delete, wiki.edit, wiki.manage_entity, wiki.view
slug
string
URL-friendly identifier used in public links.
title
string
Display name for this record.Min: 1
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create role

https://api.plutio.com/v1.11/roles

Creates a new role in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1
PUT

Update role

https://api.plutio.com/v1.11/roles

Updates the fields of an existing role. Only the fields you include in the body are changed; everything else stays the same.

No required fields for this request. Any fields from the schema above are accepted.

DELETE

Delete role

https://api.plutio.com/v1.11/roles

Permanently deletes this role from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
newRole
string
New role
slug
string
URL-friendly identifier used in public links.

Projects

A project is the main container for work in Plutio. Inside a project you will find tasks, boards, files, conversations, time entries, and team members all organized together. You might create one project per client engagement or one project per deliverable. Projects have a status, a start and end date, and can be connected to proposals, contracts, and invoices so everything related to a piece of work stays in one place.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
allowedCustomFields
object
Which custom field types are available for this resource.
allowedCustomFields.task
array
Task
allowedCustomFields.task.$
string
Task
billingRate
number
Hourly rate applied when converting tracked time into a billable amount.Min: 0
budget
object
Budget settings for this project.
budget.amount
number
AmountMin: 0
budget.amountUsed
number
Amount usedMin: 0
businessId
string
ID of the workspace this record belongs to.
clients
array
People or companies set as clients on this record.
clients.$
object
Clients
clients.$._id
string
ID
clients.$.entityType
string
Entity typeAllowed: company, person
color
string
Display color for this record.
contributors
array
Profile IDs of people who contributed to this record.
contributors.$
string
Contributors
coverImage
object
Cover image displayed at the top of this record.
coverImage._id
string
ID
coverImage.extension
string
Extension
coverImage.group
string
Group
coverImage.handle
string
Handle
coverImage.mimeType
string
Mime typeMax: 256
coverImage.size
number
Size
coverImage.title
string
TitleMin: 1Max: 500
coverImage.url
string
Url
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 30000
dueDate
date
Deadline for this record.
dueDateTemplate
number
Formula for calculating the due date automatically.Min: 0
hasDescription
boolean
True if a description has been set.
index
number
Sort position within its parent list.Min: 0
isArchived
boolean
This record has been archived and is hidden from main views.
isBillable
boolean
Time tracked in this project can be billed to a client.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
lastMessage
object
The most recent message in this conversation.
lastMessage.createdAt
date
Created at
name
string
Display name.Min: 1Max: 500
nameSortKey
string
Lowercase normalized version of name used for sorting.
navigation
object
Navigation menu structure for this project.
shareSettings
object
Controls who can view this via a shared link.
shareSettings.fields
array
Fields
shareSettings.fields.$
string
Fields
shareSettings.isShared
boolean
Is shared
shareSettings.messengerId
string
Messenger ID
shareSettings.sharedBoards
array
Shared boards
shareSettings.sharedBoards.$
string
Shared boards
shareSettings.url
string
UrlMin: 2Max: 50
startDate
date
Start date for this record.
startDateTemplate
number
Formula for calculating the start date automatically.Min: 0
status
object
Current status of this record. Values vary by resource.
status._id
string
ID
status.color
string
Color
status.textColor
string
Text color
status.title
string
TitleMax: 256
status.type
string
TypeAllowed: active, closed, completed, open
taskBoards
array
Task boards in this project.
taskBoards.$
string
Task boards
taskCounts
object
Number of tasks per status.
taskCounts.$
object
Task counts
taskCounts.$.all
number
AllMin: 0
taskCounts.$.completed
number
CompletedMin: 0
taskCounts.$.overdue
number
OverdueMin: 0
templateId
string
Template this record was created from.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create project

https://api.plutio.com/v1.11/projects

Creates a new project in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Move project

https://api.plutio.com/v1.11/projects/move

Moves this project to a different location. Useful for reorganising without having to recreate it.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
index
number
Sort position within its parent list.Min: 0
POST

Copy project

https://api.plutio.com/v1.11/projects/copy

Creates a full copy of this project, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
index
number
Sort position within its parent list.Min: 0
POST

Archive project

https://api.plutio.com/v1.11/projects/archive

Archives this project, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive project

https://api.plutio.com/v1.11/projects/bulk/archive

Archives multiple projects in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update project

https://api.plutio.com/v1.11/projects

Updates the fields of an existing project. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update project

https://api.plutio.com/v1.11/projects/bulk

Updates multiple projects in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get project

https://api.plutio.com/v1.11/projects

Returns a list of all projects in your workspace.

DELETE

Delete project

https://api.plutio.com/v1.11/projects

Permanently deletes this project from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete project

https://api.plutio.com/v1.11/projects/bulk

Permanently deletes multiple projects in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Task Boards

A task board is a Kanban-style view for managing tasks inside a project. The board is made up of columns called task groups and tasks move from one column to the next as work progresses. You can have multiple boards per project, for example one board for design work and another for development, so different parts of the project have their own workflow.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.header
object
Header
designOptions.header.bgImage
object
Bg image
designOptions.header.bgImage.image
object
Image
designOptions.header.bgImage.image._id
string
ID
designOptions.header.bgImage.image.extension
string
Extension
designOptions.header.bgImage.image.group
string
Group
designOptions.header.bgImage.image.handle
string
Handle
designOptions.header.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.header.bgImage.image.size
number
Size
designOptions.header.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.header.bgImage.image.url
string
Url
designOptions.header.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.header.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.header.bgImage.repeat
boolean
Repeat
designOptions.header.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.header.block
object
Block
designOptions.header.block.bgImage
object
Bg image
designOptions.header.block.bgImage.image
object
Image
designOptions.header.block.bgImage.image._id
string
ID
designOptions.header.block.bgImage.image.extension
string
Extension
designOptions.header.block.bgImage.image.group
string
Group
designOptions.header.block.bgImage.image.handle
string
Handle
designOptions.header.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.header.block.bgImage.image.size
number
Size
designOptions.header.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.header.block.bgImage.image.url
string
Url
designOptions.header.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.header.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.header.block.bgImage.repeat
boolean
Repeat
designOptions.header.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.header.id
string
IDMin: 1Max: 100
designOptions.id
string
IDMin: 1Max: 100
designOptions.tab
object
Tab
designOptions.tab.bgColor
string
Bg color
designOptions.tab.block
object
Block
designOptions.tab.block.bgColor
string
Bg color
designOptions.tab.block.textColor
string
Text color
designOptions.tab.id
string
IDMin: 1Max: 100
designOptions.tab.textColor
string
Text color
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: person
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
projectId
string
ID of the project this record belongs to.
taskGroups
array
Columns (groups) on this board.
taskGroups.$
string
Task groups
templateId
string
Template this record was created from.
title
string
Display name for this record.Min: 1Max: 256
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create task board

https://api.plutio.com/v1.11/task-boards

Creates a new task board in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1Max: 256
POST

Move task board

https://api.plutio.com/v1.11/task-boards/move

Moves this task board to a different location. Useful for reorganising without having to recreate it.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
position
number
PositionMin: 0
projectId
string
ID of the project this record belongs to.
POST

Copy task board

https://api.plutio.com/v1.11/task-boards/copy

Creates a full copy of this task board, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
POST

Archive task board

https://api.plutio.com/v1.11/task-boards/archive

Archives this task board, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update task board

https://api.plutio.com/v1.11/task-boards

Updates the fields of an existing task board. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get task board

https://api.plutio.com/v1.11/task-boards

Returns a list of all task boards in your workspace.

DELETE

Delete task board

https://api.plutio.com/v1.11/task-boards

Permanently deletes this task board from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Task Groups

Task groups are the columns on a task board. Each group has a name like "Backlog", "In Progress", "Review", or "Done" and tasks sit inside these groups. When you create a task you assign it to a group. You can reorder groups, set colors on them, and move tasks between them to show the current state of work at a glance.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
coverImage
object
Cover image displayed at the top of this record.
coverImage._id
string
ID
coverImage.extension
string
Extension
coverImage.group
string
Group
coverImage.handle
string
Handle
coverImage.mimeType
string
Mime typeMax: 256
coverImage.size
number
Size
coverImage.title
string
TitleMin: 1Max: 500
coverImage.url
string
Url
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
emailToTaskSettings
object
Configuration for creating tasks by forwarding emails.
emailToTaskSettings.emailId
string
Email ID
emailToTaskSettings.isActive
boolean
Is active
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: person
isArchived
boolean
This record has been archived and is hidden from main views.
isDefault
boolean
This is the default item of its type in this context.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
projectId
string
ID of the project this record belongs to.
taskBoardId
string
ID of the task board this belongs to.
tasks
array
Tasks linked to this record.
tasks.$
string
Tasks
templateId
string
Template this record was created from.
title
string
Display name for this record.Min: 1Max: 256
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create task group

https://api.plutio.com/v1.11/task-groups

Creates a new task group in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
taskBoardId
string
ID of the task board this belongs to.
POST

Move task group

https://api.plutio.com/v1.11/task-groups/move

Moves this task group to a different location. Useful for reorganising without having to recreate it.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
position
number
PositionMin: 0
taskBoardId
string
ID of the task board this belongs to.
POST

Copy task group

https://api.plutio.com/v1.11/task-groups/copy

Creates a full copy of this task group, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
position
number
PositionMin: 0
taskBoardId
string
ID of the task board this belongs to.
POST

Archive task group

https://api.plutio.com/v1.11/task-groups/archive

Archives this task group, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update task group

https://api.plutio.com/v1.11/task-groups

Updates the fields of an existing task group. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get task group

https://api.plutio.com/v1.11/task-groups

Returns a list of all task groups in your workspace.

DELETE

Delete task group

https://api.plutio.com/v1.11/task-groups

Permanently deletes this task group from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Tasks

Tasks are the individual units of work inside a project. Each task can have an assignee, a due date, a description, subtasks, file attachments, comments, and time entries logged against it. Tasks live inside task groups (the columns on a board) and move from one column to the next as work progresses. For example on a branding project you might have tasks like "Design logo concepts", "Client review call", and "Final file delivery".

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
assignedBy
string
Profile ID of whoever made the assignment.
assignedTo
array
Profile ID of the person this is assigned to.
assignedTo.$
string
Assigned to
breadcrumb
array
Path showing the parent hierarchy of this item (e.g. Project > Board > Task).
breadcrumb.$
object
Breadcrumb
breadcrumb.$._id
string
ID
breadcrumb.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
breadcrumb.$.title
string
Title
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
commentsCount
number
Total number of comments posted on this record.Min: 0
completedAt
date
When this record was marked as done.
completedBy
string
Profile ID of whoever marked this as complete.
coverImage
object
Cover image displayed at the top of this record.
coverImage._id
string
ID
coverImage.extension
string
Extension
coverImage.group
string
Group
coverImage.handle
string
Handle
coverImage.mimeType
string
Mime typeMax: 256
coverImage.size
number
Size
coverImage.title
string
TitleMin: 1Max: 500
coverImage.url
string
Url
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
createdByEmail
string
Email of the person who created this record.
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 30000
dueDate
date
Deadline for this record.
dueDateRemindAt
date
When the due date reminder notification will fire.
dueDateReminder
number
Reminder schedule settings for the due date.Min: 0Max: 720000
dueDateTemplate
number
Formula for calculating the due date automatically.Min: 0
filesCount
number
Total number of files attached.Min: 0
followers
array
Profile IDs of people following this record for notifications.
followers.$
string
Followers
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isBlockingEvent
boolean
Marks the associated time slot as unavailable in the scheduler.
isDueDateWithTime
boolean
The due date includes a specific time, not just a date.
isPrivate
boolean
Only the owner can see this record.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isStartDateWithTime
boolean
The start date includes a specific time.
isSubtasksDependent
boolean
This task cannot be marked done until all its subtasks are complete.
isTemplate
boolean
Saved as a reusable template.
parentTask
object
The task this subtask belongs to.
parentTaskId
string
ID of the parent task.
privatelySharedWith
array
Profiles this private record has been explicitly shared with.
privatelySharedWith.$
string
Privately shared with
projectId
string
ID of the project this record belongs to.
repeat
object
Recurrence settings for this item. Used on events, tasks, and subscriptions.
repeat.action
string
ActionAllowed: change_due_date, create_new
repeat.count
integer
CountMin: 2Max: 10000
repeat.interval
number
IntervalMin: 0Max: 500
repeat.intervalType
string
Interval typeAllowed: day, month, week, year
repeat.isPositional
boolean
Is positional
repeat.monthDay
number
Month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
repeat.pos
integer
PosMin: -1Max: 4
repeat.repeatedTimes
integer
Repeated timesMin: 0Max: 10000
repeat.rrule
string
RruleMax: 500
repeat.stopCondition
string
Stop conditionAllowed: count, never, until
repeat.until
date
Until
repeat.weekDays
array
Week days
repeat.weekDays.$
string
Week daysAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
repeat.yearMonth
number
Year monthAllowed: 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
repeat.yearMonthDay
number
Year month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
startDate
date
Start date for this record.
startDateRemindAt
date
When the start date reminder fires.
startDateReminder
number
Reminder configuration for the start date.Min: 0Max: 720000
startDateTemplate
number
Formula for calculating the start date automatically.Min: 0
status
string
Current status of this record. Values vary by resource.Allowed: completed, incomplete, overdue
subTasks
array
Child tasks under this task.
subTasks.$
object
Sub tasks
subTasks.$._id
string
ID
subTasks.$.assignedBy
string
Assigned by
subTasks.$.assignedTo
array
Assigned to
subTasks.$.assignedTo.$
string
Assigned to
subTasks.$.breadcrumb
array
Breadcrumb
subTasks.$.breadcrumb.$
object
Breadcrumb
subTasks.$.breadcrumb.$._id
string
ID
subTasks.$.breadcrumb.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
subTasks.$.breadcrumb.$.title
string
Title
subTasks.$.businessId
string
Business ID
subTasks.$.color
string
Color
subTasks.$.commentsCount
number
Comments countMin: 0
subTasks.$.completedAt
date
Completed at
subTasks.$.completedBy
string
Completed by
subTasks.$.coverImage
object
Cover image
subTasks.$.coverImage._id
string
ID
subTasks.$.coverImage.extension
string
Extension
subTasks.$.coverImage.group
string
Group
subTasks.$.coverImage.handle
string
Handle
subTasks.$.coverImage.mimeType
string
Mime typeMax: 256
subTasks.$.coverImage.size
number
Size
subTasks.$.coverImage.title
string
TitleMin: 1Max: 500
subTasks.$.coverImage.url
string
Url
subTasks.$.createdAt
date
Created at
subTasks.$.createdBy
string
Created by
subTasks.$.createdByEmail
string
Created by email
subTasks.$.customFields
array
Custom fields
subTasks.$.customFields.$
object
Custom fields
subTasks.$.customFields.$._id
string
ID
subTasks.$.customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
subTasks.$.customFields.$.value
string
Value
subTasks.$.customFields.$.value.$
string
Value
subTasks.$.customFields.$.value.$._id
string
ID
subTasks.$.customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
subTasks.$.customFields.$.value.$.max
number
Max
subTasks.$.customFields.$.value.$.min
number
Min
subTasks.$.descriptionHTML
string
Description html
subTasks.$.descriptionPlain
string
Description plainMax: 30000
subTasks.$.dueDate
date
Due date
subTasks.$.dueDateRemindAt
date
Due date remind at
subTasks.$.dueDateReminder
number
Due date reminderMin: 0Max: 720000
subTasks.$.dueDateTemplate
number
Due date templateMin: 0
subTasks.$.filesCount
number
Files countMin: 0
subTasks.$.followers
array
Followers
subTasks.$.followers.$
string
Followers
subTasks.$.hasDescription
boolean
Has description
subTasks.$.isArchived
boolean
Is archived
subTasks.$.isBlockingEvent
boolean
Is blocking event
subTasks.$.isDueDateWithTime
boolean
Is due date with time
subTasks.$.isPrivate
boolean
Is private
subTasks.$.isSharedPublicly
boolean
Is shared publicly
subTasks.$.isStartDateWithTime
boolean
Is start date with time
subTasks.$.isTemplate
boolean
Is template
subTasks.$.parentTaskId
string
Parent task ID
subTasks.$.privatelySharedWith
array
Privately shared with
subTasks.$.privatelySharedWith.$
string
Privately shared with
subTasks.$.projectId
string
Project ID
subTasks.$.repeat
object
Repeat
subTasks.$.repeat.action
string
ActionAllowed: change_due_date, create_new
subTasks.$.repeat.count
integer
CountMin: 2Max: 10000
subTasks.$.repeat.interval
number
IntervalMin: 0Max: 500
subTasks.$.repeat.intervalType
string
Interval typeAllowed: day, month, week, year
subTasks.$.repeat.isPositional
boolean
Is positional
subTasks.$.repeat.monthDay
number
Month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
subTasks.$.repeat.pos
integer
PosMin: -1Max: 4
subTasks.$.repeat.repeatedTimes
integer
Repeated timesMin: 0Max: 10000
subTasks.$.repeat.rrule
string
RruleMax: 500
subTasks.$.repeat.stopCondition
string
Stop conditionAllowed: count, never, until
subTasks.$.repeat.until
date
Until
subTasks.$.repeat.weekDays
array
Week days
subTasks.$.repeat.weekDays.$
string
Week daysAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
subTasks.$.repeat.yearMonth
number
Year monthAllowed: 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
subTasks.$.repeat.yearMonthDay
number
Year month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
subTasks.$.startDate
date
Start date
subTasks.$.startDateRemindAt
date
Start date remind at
subTasks.$.startDateReminder
number
Start date reminderMin: 0Max: 720000
subTasks.$.startDateTemplate
number
Start date templateMin: 0
subTasks.$.status
string
StatusAllowed: completed, incomplete, overdue
subTasks.$.taskBoardId
string
Task board ID
subTasks.$.taskGroupId
string
Task group ID
subTasks.$.taskId
string
Task ID
subTasks.$.templateId
string
Template ID
subTasks.$.title
string
TitleMin: 1Max: 500
subTasks.$.titleSortKey
string
Title sort key
subTasks.$.totalTimeTracked
number
Total time tracked
subTasks.$.trashBinId
string
Trash bin ID
subTasks.$.updatedAt
date
Updated at
taskBoardId
string
ID of the task board this belongs to.
taskGroupId
string
ID of the column this task sits in.
taskId
string
ID of the linked task.
templateId
string
Template this record was created from.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
totalTimeTracked
number
Total time logged against this record, in minutes.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create task

https://api.plutio.com/v1.11/tasks

Creates a new task in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Move task

https://api.plutio.com/v1.11/tasks/move

Moves this task to a different location. Useful for reorganising without having to recreate it.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
position
number
PositionMin: 0
POST

Copy task

https://api.plutio.com/v1.11/tasks/copy

Creates a full copy of this task, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
position
number
PositionMin: 0
POST

Archive task

https://api.plutio.com/v1.11/tasks/archive

Archives this task, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive task

https://api.plutio.com/v1.11/tasks/bulk/archive

Archives multiple tasks in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update task

https://api.plutio.com/v1.11/tasks

Updates the fields of an existing task. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update task

https://api.plutio.com/v1.11/tasks/bulk

Updates multiple tasks in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get task

https://api.plutio.com/v1.11/tasks

Returns a list of all tasks in your workspace.

DELETE

Delete task

https://api.plutio.com/v1.11/tasks

Permanently deletes this task from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete task

https://api.plutio.com/v1.11/tasks/bulk

Permanently deletes multiple tasks in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Statuses

Statuses are the workflow states you can apply to projects and conversations. For example you might define statuses like "Planning", "Active", "Awaiting Feedback", "Completed", and "On Hold". Each status gets a custom color and label so your team always knows at a glance where something stands. You can define different status sets for different types of work.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
entityType
string
Resource type this item is attached to.Allowed: conversation, project
index
number
Sort position within its parent list.
isArchived
boolean
This record has been archived and is hidden from main views.
textColor
string
Text color for labels or badges on this item.
title
string
Display name for this record.Min: 1Max: 256
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: active, closed, completed, open
updatedAt
date
When this record was last modified.
POST

Create status

https://api.plutio.com/v1.11/statuses

Creates a new status in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityType
string
Resource type this item is attached to.Allowed: conversation, project
title
string
Display name for this record.Min: 1Max: 256
POST

Move status

https://api.plutio.com/v1.11/statuses/move

Moves this status to a different location. Useful for reorganising without having to recreate it.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update status

https://api.plutio.com/v1.11/statuses

Updates the fields of an existing status. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get status

https://api.plutio.com/v1.11/statuses

Returns a list of all statuses in your workspace.

DELETE

Delete status

https://api.plutio.com/v1.11/statuses

Permanently deletes this status from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Time Entries

Time entries record how much time your team spends on tasks and projects. You can log time manually by entering hours and a note like "Worked on homepage wireframes", or you can use the built-in timer to track time in real-time while you work. Each time entry is linked to a specific task or project and you can attach an hourly billing rate so the time can be converted into an invoice line item automatically when it comes time to bill the client.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
billingAmount
number
Amount charged each billing cycle.
billingRate
number
Hourly rate applied when converting tracked time into a billable amount.Min: 0
billingRatePaidAt
date
When this billed time entry was marked as paid.
billingStatus
string
Payment status for this time entry: unpaid, invoiced, paid, or non-billable.Allowed: invoiced, non-billable, paid, unpaid
businessId
string
ID of the workspace this record belongs to.
categoryId
string
ID of the category tag applied to this record.
costAmount
number
Your internal cost for this work (separate from what you bill the client).
costRate
number
Your hourly internal cost rate.Min: 0
costRatePaidAt
date
When this cost entry was settled.
costStatus
string
Whether your internal cost has been paid or is outstanding.Allowed: paid, unpaid
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 10000
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isManualTime
boolean
Time was entered manually rather than tracked with the timer.
personId
string
ID of the person contact linked to this record.
projectId
string
ID of the project this record belongs to.
startedAt
date
When work on this record began.
status
string
Current status of this record. Values vary by resource.Allowed: active, inactive, paused
stoppedAt
date
When the timer was stopped.
taskId
string
ID of the linked task.
time
number
Total tracked duration in minutes.
times
array
Array of individual timer intervals, each with a start time, stop time, and duration in minutes.
times.$
object
Times
times.$.startedAt
date
Started at
times.$.stoppedAt
date
Stopped at
times.$.time
number
Time
title
string
Display name for this record.Min: 1Max: 500
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create time entry

https://api.plutio.com/v1.11/time-tracks

Creates a new time entry in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update time entry

https://api.plutio.com/v1.11/time-tracks

Updates the fields of an existing time entry. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update time entry

https://api.plutio.com/v1.11/time-tracks/bulk

Updates multiple time entries in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get time entry

https://api.plutio.com/v1.11/time-tracks

Returns a list of all time entries in your workspace.

DELETE

Delete time entry

https://api.plutio.com/v1.11/time-tracks

Permanently deletes this time entry from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete time entry

https://api.plutio.com/v1.11/time-tracks/bulk

Permanently deletes multiple time entries in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Categories

Categories let you organize and classify your snippets (canned responses). For example you might have categories like "Sales Replies", "Support Responses", and "Follow-ups" so your team can quickly find the right snippet when replying to a client. You can filter and search snippets by category.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
count
number
Number of records linked to or using this item.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 1000
entityType
string
Resource type this item is attached to.Allowed: canned-response
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
title
string
Display name for this record.Min: 1Max: 200
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
usedFor
array
The resource types this category can be applied to.
usedFor.$
string
Used forAllowed: contract, document, form, inbox, invoice, item, project, proposal, task
POST

Create category

https://api.plutio.com/v1.11/categories

Creates a new category in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityType
string
Resource type this item is attached to.Allowed: canned-response
title
string
Display name for this record.Min: 1Max: 200
PUT

Update category

https://api.plutio.com/v1.11/categories

Updates the fields of an existing category. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get category

https://api.plutio.com/v1.11/categories

Returns a list of all categories in your workspace.

DELETE

Delete category

https://api.plutio.com/v1.11/categories

Permanently deletes this category from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Schedulers

Schedulers are booking pages that let clients or team members schedule time with you directly. You set your availability (which days and hours you are free), define how long each appointment should be, and Plutio generates a public booking URL you can share. When someone books a slot an event is automatically created in Plutio and both parties receive a confirmation.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
buffers
object
Gap time added before and after scheduler appointments.
buffers.afterEvent
integer
After eventMin: 0
buffers.beforeEvent
integer
Before eventMin: 0
buffers.minTimeBeforeScheduling
integer
Min time before schedulingMin: 0
businessId
string
ID of the workspace this record belongs to.
confirmationBlocks
array
Content shown on the booking confirmation page.
confirmationBlocks.$
string
Confirmation blocks
confirmationBlocksDesignOptions
object
Design settings for the booking confirmation page.
confirmationBlocksLayout
array
Block layout for the booking confirmation page.
confirmationBlocksLayout.$
object
Confirmation blocks layout
confirmationBlocksLayout.$._id
string
ID
confirmationBlocksLayout.$.blocks
array
Blocks
confirmationBlocksLayout.$.blocks.$
string
Blocks
confirmationBlocksLayout.$.mobileOrder
array
Mobile order
confirmationBlocksLayout.$.mobileOrder.$
string
Mobile order
confirmationBlocksLayout.$.settings
object
Settings
confirmationBlocksUsage
object
Block types used on the booking confirmation page.
coverImage
object
Cover image displayed at the top of this record.
coverImage._id
string
ID
coverImage.extension
string
Extension
coverImage.group
string
Group
coverImage.handle
string
Handle
coverImage.mimeType
string
Mime typeMax: 256
coverImage.size
number
Size
coverImage.title
string
TitleMin: 1Max: 500
coverImage.url
string
Url
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customAvailableTimes
array
Hand-picked time slots that override the default availability schedule.
customAvailableTimes.$
object
Custom available times
customAvailableTimes.$.date
string
Date
customAvailableTimes.$.times
array
Times
customAvailableTimes.$.times.$
object
Times
customAvailableTimes.$.times.$.end
string
End
customAvailableTimes.$.times.$.start
string
Start
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
description
string
Optional text description.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonBg
string
Button bg
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonText
string
Button text
designOptions.css
string
CssMax: 5000
designOptions.descriptionColor
string
Description color
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.labelColor
string
Label color
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.pageBgColor
string
Page bg color
designOptions.scheduler
object
Scheduler
designOptions.scheduler.available
object
Available
designOptions.scheduler.available.bgColor
string
Bg color
designOptions.scheduler.available.textColor
string
Text color
designOptions.scheduler.bgColor
string
Bg color
designOptions.scheduler.border
object
Border
designOptions.scheduler.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.scheduler.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.scheduler.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.scheduler.border.left
integer
LeftMin: -1000Max: 1000
designOptions.scheduler.border.right
integer
RightMin: -1000Max: 1000
designOptions.scheduler.border.top
integer
TopMin: -1000Max: 1000
designOptions.scheduler.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.scheduler.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.scheduler.borderColor
string
Border color
designOptions.scheduler.selected
object
Selected
designOptions.scheduler.selected.bgColor
string
Bg color
designOptions.scheduler.selected.border
object
Border
designOptions.scheduler.selected.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.scheduler.selected.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.scheduler.selected.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.scheduler.selected.border.left
integer
LeftMin: -1000Max: 1000
designOptions.scheduler.selected.border.right
integer
RightMin: -1000Max: 1000
designOptions.scheduler.selected.border.top
integer
TopMin: -1000Max: 1000
designOptions.scheduler.selected.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.scheduler.selected.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.scheduler.selected.borderColor
string
Border color
designOptions.scheduler.selected.textColor
string
Text color
designOptions.scheduler.shadow
object
Shadow
designOptions.scheduler.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.scheduler.shadow.color
string
Color
designOptions.scheduler.shadow.x
integer
XMin: -1000Max: 1000
designOptions.scheduler.shadow.y
integer
YMin: -1000Max: 1000
designOptions.scheduler.textColor
string
Text color
designOptions.scheduler.todayMarkerBgColor
string
Today marker bg color
designOptions.section
object
Section
designOptions.section.bgColor
string
Bg color
designOptions.section.bgImage
object
Bg image
designOptions.section.bgImage.image
object
Image
designOptions.section.bgImage.image._id
string
ID
designOptions.section.bgImage.image.extension
string
Extension
designOptions.section.bgImage.image.group
string
Group
designOptions.section.bgImage.image.handle
string
Handle
designOptions.section.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.section.bgImage.image.size
number
Size
designOptions.section.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.section.bgImage.image.url
string
Url
designOptions.section.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.section.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.section.bgImage.repeat
boolean
Repeat
designOptions.section.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.section.border
object
Border
designOptions.section.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.section.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.section.border.left
integer
LeftMin: -1000Max: 1000
designOptions.section.border.right
integer
RightMin: -1000Max: 1000
designOptions.section.border.top
integer
TopMin: -1000Max: 1000
designOptions.section.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.section.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.section.borderColor
string
Border color
designOptions.section.css
string
CssMax: 5000
designOptions.section.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.section.id
string
IDMin: 1Max: 100
designOptions.section.margin
object
Margin
designOptions.section.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.section.margin.right
integer
RightMin: -1000Max: 1000
designOptions.section.margin.top
integer
TopMin: -1000Max: 1000
designOptions.section.padding
object
Padding
designOptions.section.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.section.padding.right
integer
RightMin: -1000Max: 1000
designOptions.section.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section.shadow
object
Shadow
designOptions.section.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.section.shadow.color
string
Color
designOptions.section.shadow.x
integer
XMin: -1000Max: 1000
designOptions.section.shadow.y
integer
YMin: -1000Max: 1000
designOptions.section.textColor
string
Text color
designOptions.section.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
durations
array
Time duration slots (used on schedulers for appointment lengths).
durations.$
object
Durations
durations.$.costRate
number
Cost rateMin: 0
durations.$.duration
integer
DurationMin: 0
formBlocks
array
Fields and content that make up this form.
formBlocks.$
string
Form blocks
formBlocksDesignOptions
object
Design settings applied to this form.
formBlocksLayout
array
Block order and layout for this form.
formBlocksLayout.$
object
Form blocks layout
formBlocksLayout.$._id
string
ID
formBlocksLayout.$.blocks
array
Blocks
formBlocksLayout.$.blocks.$
string
Blocks
formBlocksLayout.$.mobileOrder
array
Mobile order
formBlocksLayout.$.mobileOrder.$
string
Mobile order
formBlocksLayout.$.settings
object
Settings
formBlocksUsage
object
Block types used inside this form.
inheritLocale
boolean
Use the workspace language instead of a custom one.
isArchived
boolean
This record has been archived and is hidden from main views.
isAutoSendReceipt
boolean
Send a payment receipt automatically when payment is received.
isCollectPayment
boolean
Collect payment at the time of booking.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
limits
object
Booking limits for this scheduler.
limits.acceptBookingWithin
integer
Accept booking withinMin: 0
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
location
string
Physical address or meeting place for this booking page.
locationProvider
string
Video call platform for this booking page: Google Meet or Zoom.Allowed: google-meet, zoom
locationType
string
How the appointment is held: Google Meet, Zoom, a physical address, or a custom link.Allowed: address, google-meet, manual-link, zoom
meta
object
System metadata for this record.
meta.bookingsCount
number
Bookings countMin: 0
name
string
Display name.Min: 1Max: 500
nameSortKey
string
Lowercase normalized version of name used for sorting.
notificationOptions
object
Which event notifications are enabled.
notificationOptions.organizers
object
Organizers
notificationOptions.organizers.cancellation
object
Cancellation
notificationOptions.organizers.cancellation.email
object
Email
notificationOptions.organizers.cancellation.email.isEnabled
boolean
Is enabled
notificationOptions.organizers.cancellation.push
object
Push
notificationOptions.organizers.cancellation.push.isEnabled
boolean
Is enabled
notificationOptions.organizers.confirmation
object
Confirmation
notificationOptions.organizers.confirmation.email
object
Email
notificationOptions.organizers.confirmation.email.isEnabled
boolean
Is enabled
notificationOptions.organizers.confirmation.push
object
Push
notificationOptions.organizers.confirmation.push.isEnabled
boolean
Is enabled
notificationOptions.organizers.due
object
Due
notificationOptions.organizers.due.email
object
Email
notificationOptions.organizers.due.email.isEnabled
boolean
Is enabled
notificationOptions.organizers.due.push
object
Push
notificationOptions.organizers.due.push.isEnabled
boolean
Is enabled
notificationOptions.recipient
object
Recipient
notificationOptions.recipient.cancellation
object
Cancellation
notificationOptions.recipient.cancellation.email
object
Email
notificationOptions.recipient.cancellation.email.isEnabled
boolean
Is enabled
notificationOptions.recipient.confirmation
object
Confirmation
notificationOptions.recipient.confirmation.email
object
Email
notificationOptions.recipient.confirmation.email.isEnabled
boolean
Is enabled
notificationOptions.recipient.due
object
Due
notificationOptions.recipient.due.email
object
Email
notificationOptions.recipient.due.email.isEnabled
boolean
Is enabled
notificationOptions.recipient.reminder
object
Reminder
notificationOptions.recipient.reminder.email
object
Email
notificationOptions.recipient.reminder.email.isEnabled
boolean
Is enabled
notificationOptions.recipient.reminder.minutesBefore
number
Minutes beforeMin: 0Max: 720000
organizers
array
Profile IDs of event organizers.
organizers.$
string
Organizers
paymentOptions
array
Payment methods the client can use to pay this invoice.
paymentOptions.$
string
Payment options
receiptTemplateId
string
Template used when generating receipts.
schedulerBlocks
array
Content blocks on this booking page.
schedulerBlocks.$
string
Scheduler blocks
schedulerBlocksDesignOptions
object
Design settings for this booking page.
schedulerBlocksLayout
array
Block layout for this booking page.
schedulerBlocksLayout.$
object
Scheduler blocks layout
schedulerBlocksLayout.$._id
string
ID
schedulerBlocksLayout.$.blocks
array
Blocks
schedulerBlocksLayout.$.blocks.$
string
Blocks
schedulerBlocksLayout.$.mobileOrder
array
Mobile order
schedulerBlocksLayout.$.mobileOrder.$
string
Mobile order
schedulerBlocksLayout.$.settings
object
Settings
schedulerBlocksUsage
object
Block types used on this booking page.
schedulerId
string
ID of the linked booking page.
status
string
Current status of this record. Values vary by resource.Allowed: active, draft, inactive
templateId
string
Template this record was created from.
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
title
string
Display name for this record.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create scheduler

https://api.plutio.com/v1.11/scheduler

Creates a new scheduler in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Copy scheduler

https://api.plutio.com/v1.11/scheduler/copy

Creates a full copy of this scheduler, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
POST

Archive scheduler

https://api.plutio.com/v1.11/scheduler/archive

Archives this scheduler, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive scheduler

https://api.plutio.com/v1.11/scheduler/bulk/archive

Archives multiple schedulers in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update scheduler

https://api.plutio.com/v1.11/scheduler

Updates the fields of an existing scheduler. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update scheduler

https://api.plutio.com/v1.11/scheduler/bulk

Updates multiple schedulers in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get scheduler

https://api.plutio.com/v1.11/scheduler

Returns a list of all schedulers in your workspace.

DELETE

Delete scheduler

https://api.plutio.com/v1.11/scheduler

Permanently deletes this scheduler from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete scheduler

https://api.plutio.com/v1.11/scheduler/bulk

Permanently deletes multiple schedulers in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Events

Events are calendar entries in Plutio. You might use them for client meetings, project kickoffs, deadline reminders, discovery calls, or team check-ins. Each event has a title, date, time, duration, and optional participants. Events show up on the Plutio calendar and can be linked to specific projects or people so everything stays organized and visible in the right context.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
attendeeResponse
string
The attendee's RSVP status: accepted, declined, tentative, or needsAction.Allowed: accepted, declined, needsAction, tentative
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 5000
endDate
date
End date for this record.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: scheduler-booking
excludedDates
array
Specific dates on which this recurring event does not occur.
excludedDates.$
string
Excluded dates
hasDescription
boolean
True if a description has been set.
isAllDay
boolean
Event runs all day with no specific start or end time.
isArchived
boolean
This record has been archived and is hidden from main views.
isBlockingEvent
boolean
Marks the associated time slot as unavailable in the scheduler.
participants
array
Everyone involved in this record.
participants.$
string
Participants
projectId
string
ID of the project this record belongs to.
repeat
object
Recurrence settings for this item. Used on events, tasks, and subscriptions.
repeat.action
string
ActionAllowed: change_due_date, create_new
repeat.count
integer
CountMin: 2Max: 10000
repeat.interval
number
IntervalMin: 0Max: 500
repeat.intervalType
string
Interval typeAllowed: day, month, week, year
repeat.isPositional
boolean
Is positional
repeat.monthDay
number
Month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
repeat.pos
integer
PosMin: -1Max: 4
repeat.repeatedTimes
integer
Repeated timesMin: 0Max: 10000
repeat.rrule
string
RruleMax: 500
repeat.stopCondition
string
Stop conditionAllowed: count, never, until
repeat.until
date
Until
repeat.weekDays
array
Week days
repeat.weekDays.$
string
Week daysAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
repeat.yearMonth
number
Year monthAllowed: 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
repeat.yearMonthDay
number
Year month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
service
object
External integration this record is connected to.
service.calendarId
string
Calendar ID
service.itemId
string
Item ID
service.type
string
Type
service.updateId
string
Update ID
startDate
date
Start date for this record.
startDateRemindAt
date
When the start date reminder fires.
startDateReminder
number
Reminder configuration for the start date.Min: 0Max: 720000
title
string
Display name for this record.Min: 2Max: 500
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create event

https://api.plutio.com/v1.11/events

Creates a new event in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
startDate
date
Start date for this record.
title
string
Display name for this record.Min: 2Max: 500
PUT

Update event

https://api.plutio.com/v1.11/events

Updates the fields of an existing event. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get event

https://api.plutio.com/v1.11/events

Returns a list of all events in your workspace.

DELETE

Delete event

https://api.plutio.com/v1.11/events

Permanently deletes this event from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Invoices

Invoices are the financial documents you send to clients to request payment. Each invoice has line items listing the products or services being billed, optional taxes and discounts, a due date, and a total amount. You can send invoices directly from Plutio and clients can pay online via the integrated payment gateway. The API lets you create, update, and query invoices programmatically so you can automate billing from your own system or sync with accounting software.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
amount
number
The monetary amount for this record.
amountBeforeSplit
number
Original invoice total before it was divided into instalments.
amountSplitDue
number
Remaining balance still owed across split payments.
amountSplitPaid
number
Amount already collected from split payments.
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
cancelledAt
date
When this record was cancelled.
client
object
The client contact linked to this record.
client._id
string
ID
client.entityType
string
Entity typeAllowed: company, person
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.contact
object
Contact
designOptions.contact.bgColor
string
Bg color
designOptions.contact.bgImage
object
Bg image
designOptions.contact.bgImage.image
object
Image
designOptions.contact.bgImage.image._id
string
ID
designOptions.contact.bgImage.image.extension
string
Extension
designOptions.contact.bgImage.image.group
string
Group
designOptions.contact.bgImage.image.handle
string
Handle
designOptions.contact.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.contact.bgImage.image.size
number
Size
designOptions.contact.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.contact.bgImage.image.url
string
Url
designOptions.contact.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.contact.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.contact.bgImage.repeat
boolean
Repeat
designOptions.contact.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.contact.border
object
Border
designOptions.contact.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.contact.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.contact.border.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.border.right
integer
RightMin: -1000Max: 1000
designOptions.contact.border.top
integer
TopMin: -1000Max: 1000
designOptions.contact.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.contact.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.contact.borderColor
string
Border color
designOptions.contact.css
string
CssMax: 5000
designOptions.contact.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.contact.id
string
IDMin: 1Max: 100
designOptions.contact.margin
object
Margin
designOptions.contact.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.margin.right
integer
RightMin: -1000Max: 1000
designOptions.contact.margin.top
integer
TopMin: -1000Max: 1000
designOptions.contact.padding
object
Padding
designOptions.contact.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.padding.right
integer
RightMin: -1000Max: 1000
designOptions.contact.padding.top
integer
TopMin: -1000Max: 1000
designOptions.contact.shadow
object
Shadow
designOptions.contact.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.contact.shadow.color
string
Color
designOptions.contact.shadow.x
integer
XMin: -1000Max: 1000
designOptions.contact.shadow.y
integer
YMin: -1000Max: 1000
designOptions.contact.textColor
string
Text color
designOptions.contact.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section
object
Section
designOptions.section.bgColor
string
Bg color
designOptions.section.bgImage
object
Bg image
designOptions.section.bgImage.image
object
Image
designOptions.section.bgImage.image._id
string
ID
designOptions.section.bgImage.image.extension
string
Extension
designOptions.section.bgImage.image.group
string
Group
designOptions.section.bgImage.image.handle
string
Handle
designOptions.section.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.section.bgImage.image.size
number
Size
designOptions.section.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.section.bgImage.image.url
string
Url
designOptions.section.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.section.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.section.bgImage.repeat
boolean
Repeat
designOptions.section.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.section.border
object
Border
designOptions.section.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.section.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.section.border.left
integer
LeftMin: -1000Max: 1000
designOptions.section.border.right
integer
RightMin: -1000Max: 1000
designOptions.section.border.top
integer
TopMin: -1000Max: 1000
designOptions.section.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.section.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.section.borderColor
string
Border color
designOptions.section.css
string
CssMax: 5000
designOptions.section.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.section.id
string
IDMin: 1Max: 100
designOptions.section.margin
object
Margin
designOptions.section.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.section.margin.right
integer
RightMin: -1000Max: 1000
designOptions.section.margin.top
integer
TopMin: -1000Max: 1000
designOptions.section.padding
object
Padding
designOptions.section.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.section.padding.right
integer
RightMin: -1000Max: 1000
designOptions.section.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section.shadow
object
Shadow
designOptions.section.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.section.shadow.color
string
Color
designOptions.section.shadow.x
integer
XMin: -1000Max: 1000
designOptions.section.shadow.y
integer
YMin: -1000Max: 1000
designOptions.section.textColor
string
Text color
designOptions.section.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary
object
Summary
designOptions.summary.bgColor
string
Bg color
designOptions.summary.bgImage
object
Bg image
designOptions.summary.bgImage.image
object
Image
designOptions.summary.bgImage.image._id
string
ID
designOptions.summary.bgImage.image.extension
string
Extension
designOptions.summary.bgImage.image.group
string
Group
designOptions.summary.bgImage.image.handle
string
Handle
designOptions.summary.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summary.bgImage.image.size
number
Size
designOptions.summary.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summary.bgImage.image.url
string
Url
designOptions.summary.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summary.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summary.bgImage.repeat
boolean
Repeat
designOptions.summary.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summary.border
object
Border
designOptions.summary.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summary.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summary.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.border.right
integer
RightMin: -1000Max: 1000
designOptions.summary.border.top
integer
TopMin: -1000Max: 1000
designOptions.summary.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summary.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summary.borderColor
string
Border color
designOptions.summary.css
string
CssMax: 5000
designOptions.summary.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summary.id
string
IDMin: 1Max: 100
designOptions.summary.margin
object
Margin
designOptions.summary.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summary.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summary.padding
object
Padding
designOptions.summary.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summary.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summary.shadow
object
Shadow
designOptions.summary.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summary.shadow.color
string
Color
designOptions.summary.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summary.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary.textColor
string
Text color
designOptions.summary.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
dueDate
date
Deadline for this record.
dueDateTemplate
number
Formula for calculating the due date automatically.Min: 0
inheritLocale
boolean
Use the workspace language instead of a custom one.
invoiceId
string
ID of the invoice linked to this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isDiscountBeforeTax
boolean
Apply the discount to the subtotal before calculating tax.
isFirstSubscriptionInvoice
boolean
This was the first invoice generated by this subscription.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isMainSplitInvoice
boolean
This is the parent invoice in a split payment arrangement.
isMainSubscriptionInvoice
boolean
This is the primary invoice tied to the subscription cycle.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
issueDate
date
The date printed on this invoice as the issue date.
issueDateTemplate
number
Formula for calculating the issue date automatically.Min: 0
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
name
string
Display name.Min: 1Max: 500
nameSortKey
string
Lowercase normalized version of name used for sorting.
paidAt
date
When this invoice was paid.
paymentId
string
ID of the associated payment transaction.
paymentMethod
object
Payment method details for this record.
paymentMethod._id
string
ID
paymentMethod.customerId
string
Customer ID
paymentMethod.meta
object
Meta
paymentMethod.meta.cardLast4
string
Card last4
paymentMethod.meta.cardType
string
Card type
paymentMethod.option
string
Option
paymentOptions
array
Payment methods the client can use to pay this invoice.
paymentOptions.$
string
Payment options
pendingAt
date
When this record entered a pending state.
projectId
string
ID of the project this record belongs to.
proposalId
string
ID of the proposal linked to this record.
receiptId
string
ID of the payment receipt.
receiptTemplateId
string
Template used when generating receipts.
reference
string
Custom reference number or code for this record.Max: 256
shouldSendReceipt
boolean
Send a receipt to the client when this invoice is paid.
splitInvoiceOptions
array
How this invoice is divided into instalment payments.Min: 2Max: 5
splitInvoiceOptions.$
object
Split invoice options
splitInvoiceOptions.$._id
string
ID
splitInvoiceOptions.$.amount
number
AmountMin: 0
splitInvoiceOptions.$.dueDate
date
Due date
splitInvoiceOptions.$.dueDateTemplate
number
Due date template
splitInvoiceOptions.$.value
string
Value
splitInvoicePart
string
Which instalment number this invoice represents.
splitInvoices
array
The individual instalment invoices for this split payment.
splitInvoices.$
string
Split invoices
status
string
Current status of this record. Values vary by resource.
subTotal
number
Total before tax and discounts.
subscriptionId
string
ID of the linked subscription.
tax
array
Tax lines applied to this record.
tax.$
object
Tax
tax.$.amount
number
Amount
tax.$.title
string
TitleMax: 100
tax.$.value
number
Value
templateId
string
Template this record was created from.
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: default, recurring_billing, recurring_invoice, split_invoice
updatedAt
date
When this record was last modified.
viewedAt
date
When this record was last opened.
POST

Create invoice

https://api.plutio.com/v1.11/invoices

Creates a new invoice in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Archive invoice

https://api.plutio.com/v1.11/invoices/archive

Archives this invoice, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive invoice

https://api.plutio.com/v1.11/invoices/bulk/archive

Archives multiple invoices in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update invoice

https://api.plutio.com/v1.11/invoices

Updates the fields of an existing invoice. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update invoice

https://api.plutio.com/v1.11/invoices/bulk

Updates multiple invoices in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get invoice

https://api.plutio.com/v1.11/invoices

Returns a list of all invoices in your workspace.

DELETE

Delete invoice

https://api.plutio.com/v1.11/invoices

Permanently deletes this invoice from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete invoice

https://api.plutio.com/v1.11/invoices/bulk

Permanently deletes multiple invoices in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Subscriptions

Subscriptions automate your recurring billing so you do not have to manually create and send invoices every cycle. You set up a subscription once by defining the billing interval (daily, weekly, monthly, or yearly), the amount, and which client it applies to, and Plutio automatically generates and sends the invoice on schedule.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
amount
number
The monetary amount for this record.
businessId
string
ID of the workspace this record belongs to.
cancelledAt
date
When this record was cancelled.
cancelledBy
string
Profile ID of whoever cancelled this record.
client
object
The client contact linked to this record.
client._id
string
ID
client.entityType
string
Entity typeAllowed: company, person
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
endAfterInvoicesCreated
integer
The subscription will cancel after this many invoices have been generated.Min: 2Max: 100
endDate
date
End date for this record.
failCount
number
Number of failed payment attempts.
failedAt
date
Timestamp of the last failure.
invoices
array
Invoices linked to this record.
invoices.$
object
Invoices
invoices.$._id
string
ID
invoices.$.createdAt
date
Created at
invoices.$.failCount
number
Fail count
invoices.$.fails
array
Fails
invoices.$.fails.$
object
Fails
invoices.$.fails.$.createdAt
date
Created at
invoices.$.fails.$.reason
string
Reason
invoices.$.paidAt
date
Paid at
invoices.$.paymentStatus
string
Payment status
invoices.$.status
string
Status
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
lastChargeAttemptedAt
date
When the most recent payment charge was attempted.
mainInvoiceId
string
The parent invoice ID when this is part of a split payment.
paymentId
string
ID of the associated payment transaction.
paymentMethod
object
Payment method details for this record.
paymentMethod._id
string
ID
paymentMethod.customerId
string
Customer ID
paymentMethod.meta
object
Meta
paymentMethod.meta.cardLast4
string
Card last4
paymentMethod.meta.cardType
string
Card type
paymentMethod.option
string
Option
paymentMethod.personId
string
Person ID
paymentOptions
array
Payment methods the client can use to pay this invoice.
paymentOptions.$
string
Payment options
projectId
string
ID of the project this record belongs to.
repeat
object
Recurrence settings for this item. Used on events, tasks, and subscriptions.
repeat.action
string
ActionAllowed: change_due_date, create_new
repeat.interval
number
IntervalMin: 0Max: 500
repeat.intervalType
string
Interval typeAllowed: day, month, week, year
repeat.isPositional
boolean
Is positional
repeat.monthDay
number
Month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
repeat.pos
integer
PosMin: -1Max: 4
repeat.rrule
string
RruleMax: 500
repeat.weekDays
array
Week days
repeat.weekDays.$
string
Week daysAllowed: friday, monday, saturday, sunday, thursday, tuesday, wednesday
repeat.yearMonth
number
Year monthAllowed: 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
repeat.yearMonthDay
number
Year month dayAllowed: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 4, 5, 6, 7, 8, 9
startDate
date
Start date for this record.
status
string
Current status of this record. Values vary by resource.Allowed: active, cancelled, draft, failed, past_due, paused
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: recurring_billing, recurring_invoice
upcomingInvoiceDate
date
When the next subscription invoice will be generated.
updatedAt
date
When this record was last modified.
POST

Create subscription

https://api.plutio.com/v1.11/invoice-subscriptions

Creates a new subscription in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update subscription

https://api.plutio.com/v1.11/invoice-subscriptions

Updates the fields of an existing subscription. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update subscription

https://api.plutio.com/v1.11/invoice-subscriptions/bulk

Updates multiple subscriptions in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get subscription

https://api.plutio.com/v1.11/invoice-subscriptions

Returns a list of all subscriptions in your workspace.

DELETE

Delete subscription

https://api.plutio.com/v1.11/invoice-subscriptions

Permanently deletes this subscription from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete subscription

https://api.plutio.com/v1.11/invoice-subscriptions/bulk

Permanently deletes multiple subscriptions in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Transactions

Transactions are records of individual payment events attached to invoices. For example when a client pays an invoice a transaction is created recording the amount paid, the date, the payment method, and whether it was successful. Transactions give you a complete audit trail of all money movement in your workspace. You can use the API to query transactions for accounting reconciliation, financial reporting, or syncing with external bookkeeping tools.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
amount
number
The monetary amount for this record.
attachments
array
Files attached to this record.
attachments.$
object
Attachments
attachments.$._id
string
ID
attachments.$.extension
string
Extension
attachments.$.group
string
Group
attachments.$.handle
string
Handle
attachments.$.mimeType
string
Mime typeMax: 256
attachments.$.size
number
Size
attachments.$.title
string
TitleMin: 1Max: 500
attachments.$.url
string
Url
businessId
string
ID of the workspace this record belongs to.
client
object
The client contact linked to this record.
client._id
string
ID
client.entityType
string
Entity typeAllowed: company, person
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.
hasDescription
boolean
True if a description has been set.
invoiceId
string
ID of the invoice linked to this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
issueDate
date
The date printed on this invoice as the issue date.
manualPaymentMethod
string
Offline payment method: check, cash, debit, credit, or wire-transfer.Allowed: cash, check, credit, debit, wire-transfer
paymentId
string
ID of the associated payment transaction.
paymentMethod
object
Payment method details for this record.
paymentMethod._id
string
ID
paymentMethod.customerId
string
Customer ID
paymentMethod.meta
object
Meta
paymentMethod.meta.cardLast4
string
Card last4
paymentMethod.meta.cardType
string
Card type
paymentMethod.option
string
Option
projectId
string
ID of the project this record belongs to.
status
string
Current status of this record. Values vary by resource.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
transactionId
string
ID of the payment transaction.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: in, out
updatedAt
date
When this record was last modified.
POST

Create transaction

https://api.plutio.com/v1.11/transactions

Creates a new transaction in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Copy transaction

https://api.plutio.com/v1.11/transactions/copy

Creates a full copy of this transaction, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
POST

Archive transaction

https://api.plutio.com/v1.11/transactions/archive

Archives this transaction, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive transaction

https://api.plutio.com/v1.11/transactions/bulk/archive

Archives multiple transactions in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update transaction

https://api.plutio.com/v1.11/transactions

Updates the fields of an existing transaction. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update transaction

https://api.plutio.com/v1.11/transactions/bulk

Updates multiple transactions in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get transaction

https://api.plutio.com/v1.11/transactions

Returns a list of all transactions in your workspace.

DELETE

Delete transaction

https://api.plutio.com/v1.11/transactions

Permanently deletes this transaction from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete transaction

https://api.plutio.com/v1.11/transactions/bulk

Permanently deletes multiple transactions in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Proposals

Proposals are the documents you send to potential clients to outline your services, pricing, and terms before any work begins. They are fully customizable with text blocks, pricing tables, images, and whatever content you need. The client can review the proposal online, accept or reject it, and sign it electronically. Once a proposal is accepted you can convert it directly into a contract and invoice without having to re-enter any information.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
amount
number
The monetary amount for this record.
approvedAt
date
When a proposal was accepted by the client.
autoInvite
boolean
Automatically invite new workspace members to this record.
autoInvoice
boolean
When enabled, automatically creates an invoice when this proposal is accepted.
autoInvoiceId
string
ID of the invoice automatically created when this proposal was accepted.
autoInvoiceTemplateId
string
Invoice template used to auto-generate the invoice when this proposal is accepted.
autoInvoiceType
string
The type of invoice to create automatically when this proposal is accepted: default or split_invoice.Allowed: default, split_invoice
autoProject
boolean
Create a new project automatically when this proposal is accepted.
billableItems
array
Time entries or expenses on this record that can be billed to a client.
billableItems.$
object
Billable items
billableItems.$._id
string
ID
billableItems.$.amount
number
Amount
billableItems.$.attachment
object
Attachment
billableItems.$.attachment._id
string
ID
billableItems.$.attachment.extension
string
Extension
billableItems.$.attachment.group
string
Group
billableItems.$.attachment.handle
string
Handle
billableItems.$.attachment.mimeType
string
Mime typeMax: 256
billableItems.$.attachment.size
number
Size
billableItems.$.attachment.title
string
TitleMin: 1Max: 500
billableItems.$.attachment.url
string
Url
billableItems.$.descriptionHTML
string
Description html
billableItems.$.descriptionPlain
string
Description plainMax: 10000
billableItems.$.discount
string
Discount
billableItems.$.discountAmount
number
Discount amount
billableItems.$.discountPercentage
number
Discount percentage
billableItems.$.hasDescription
boolean
Has description
billableItems.$.quantity
number
QuantityMin: 0
billableItems.$.subTotal
number
Sub total
billableItems.$.tax
number
Tax
billableItems.$.taxAmount
number
Tax amount
billableItems.$.title
string
TitleMax: 500
billableItems.$.totalAmount
number
Total amount
billableItems.$.totalDiscount
number
Total discount
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
cancelledAt
date
When this record was cancelled.
client
object
The client contact linked to this record.
client._id
string
ID
client.entityType
string
Entity typeAllowed: company, person
contractId
string
ID of the contract linked to this record.
contractTemplateId
string
Contract template used when auto-generating a contract from this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
declinedAt
date
When this proposal or invitation was declined.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.contact
object
Contact
designOptions.contact.bgColor
string
Bg color
designOptions.contact.bgImage
object
Bg image
designOptions.contact.bgImage.image
object
Image
designOptions.contact.bgImage.image._id
string
ID
designOptions.contact.bgImage.image.extension
string
Extension
designOptions.contact.bgImage.image.group
string
Group
designOptions.contact.bgImage.image.handle
string
Handle
designOptions.contact.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.contact.bgImage.image.size
number
Size
designOptions.contact.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.contact.bgImage.image.url
string
Url
designOptions.contact.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.contact.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.contact.bgImage.repeat
boolean
Repeat
designOptions.contact.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.contact.border
object
Border
designOptions.contact.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.contact.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.contact.border.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.border.right
integer
RightMin: -1000Max: 1000
designOptions.contact.border.top
integer
TopMin: -1000Max: 1000
designOptions.contact.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.contact.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.contact.borderColor
string
Border color
designOptions.contact.css
string
CssMax: 5000
designOptions.contact.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.contact.id
string
IDMin: 1Max: 100
designOptions.contact.margin
object
Margin
designOptions.contact.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.margin.right
integer
RightMin: -1000Max: 1000
designOptions.contact.margin.top
integer
TopMin: -1000Max: 1000
designOptions.contact.padding
object
Padding
designOptions.contact.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.padding.right
integer
RightMin: -1000Max: 1000
designOptions.contact.padding.top
integer
TopMin: -1000Max: 1000
designOptions.contact.shadow
object
Shadow
designOptions.contact.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.contact.shadow.color
string
Color
designOptions.contact.shadow.x
integer
XMin: -1000Max: 1000
designOptions.contact.shadow.y
integer
YMin: -1000Max: 1000
designOptions.contact.textColor
string
Text color
designOptions.contact.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.itemCard
object
Item card
designOptions.itemCard.bgColor
string
Bg color
designOptions.itemCard.bgImage
object
Bg image
designOptions.itemCard.bgImage.image
object
Image
designOptions.itemCard.bgImage.image._id
string
ID
designOptions.itemCard.bgImage.image.extension
string
Extension
designOptions.itemCard.bgImage.image.group
string
Group
designOptions.itemCard.bgImage.image.handle
string
Handle
designOptions.itemCard.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.itemCard.bgImage.image.size
number
Size
designOptions.itemCard.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.itemCard.bgImage.image.url
string
Url
designOptions.itemCard.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.itemCard.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.itemCard.bgImage.repeat
boolean
Repeat
designOptions.itemCard.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.itemCard.border
object
Border
designOptions.itemCard.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.itemCard.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.itemCard.border.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.border.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.border.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.itemCard.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.itemCard.borderColor
string
Border color
designOptions.itemCard.css
string
CssMax: 5000
designOptions.itemCard.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.itemCard.id
string
IDMin: 1Max: 100
designOptions.itemCard.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.itemCard.margin
object
Margin
designOptions.itemCard.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.margin.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.margin.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.padding
object
Padding
designOptions.itemCard.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.padding.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.padding.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.shadow
object
Shadow
designOptions.itemCard.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.itemCard.shadow.color
string
Color
designOptions.itemCard.shadow.x
integer
XMin: -1000Max: 1000
designOptions.itemCard.shadow.y
integer
YMin: -1000Max: 1000
designOptions.itemCard.textColor
string
Text color
designOptions.itemCard.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section
object
Section
designOptions.section.bgColor
string
Bg color
designOptions.section.bgImage
object
Bg image
designOptions.section.bgImage.image
object
Image
designOptions.section.bgImage.image._id
string
ID
designOptions.section.bgImage.image.extension
string
Extension
designOptions.section.bgImage.image.group
string
Group
designOptions.section.bgImage.image.handle
string
Handle
designOptions.section.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.section.bgImage.image.size
number
Size
designOptions.section.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.section.bgImage.image.url
string
Url
designOptions.section.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.section.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.section.bgImage.repeat
boolean
Repeat
designOptions.section.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.section.border
object
Border
designOptions.section.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.section.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.section.border.left
integer
LeftMin: -1000Max: 1000
designOptions.section.border.right
integer
RightMin: -1000Max: 1000
designOptions.section.border.top
integer
TopMin: -1000Max: 1000
designOptions.section.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.section.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.section.borderColor
string
Border color
designOptions.section.css
string
CssMax: 5000
designOptions.section.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.section.id
string
IDMin: 1Max: 100
designOptions.section.margin
object
Margin
designOptions.section.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.section.margin.right
integer
RightMin: -1000Max: 1000
designOptions.section.margin.top
integer
TopMin: -1000Max: 1000
designOptions.section.padding
object
Padding
designOptions.section.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.section.padding.right
integer
RightMin: -1000Max: 1000
designOptions.section.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section.shadow
object
Shadow
designOptions.section.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.section.shadow.color
string
Color
designOptions.section.shadow.x
integer
XMin: -1000Max: 1000
designOptions.section.shadow.y
integer
YMin: -1000Max: 1000
designOptions.section.textColor
string
Text color
designOptions.section.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.signature
object
Signature
designOptions.signature.bgColor
string
Bg color
designOptions.signature.bgImage
object
Bg image
designOptions.signature.bgImage.image
object
Image
designOptions.signature.bgImage.image._id
string
ID
designOptions.signature.bgImage.image.extension
string
Extension
designOptions.signature.bgImage.image.group
string
Group
designOptions.signature.bgImage.image.handle
string
Handle
designOptions.signature.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.signature.bgImage.image.size
number
Size
designOptions.signature.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.signature.bgImage.image.url
string
Url
designOptions.signature.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.signature.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.signature.bgImage.repeat
boolean
Repeat
designOptions.signature.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.signature.border
object
Border
designOptions.signature.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.signature.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.signature.border.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.border.right
integer
RightMin: -1000Max: 1000
designOptions.signature.border.top
integer
TopMin: -1000Max: 1000
designOptions.signature.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.signature.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.signature.borderColor
string
Border color
designOptions.signature.css
string
CssMax: 5000
designOptions.signature.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.signature.id
string
IDMin: 1Max: 100
designOptions.signature.margin
object
Margin
designOptions.signature.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.margin.right
integer
RightMin: -1000Max: 1000
designOptions.signature.margin.top
integer
TopMin: -1000Max: 1000
designOptions.signature.padding
object
Padding
designOptions.signature.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.padding.right
integer
RightMin: -1000Max: 1000
designOptions.signature.padding.top
integer
TopMin: -1000Max: 1000
designOptions.signature.shadow
object
Shadow
designOptions.signature.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.signature.shadow.color
string
Color
designOptions.signature.shadow.x
integer
XMin: -1000Max: 1000
designOptions.signature.shadow.y
integer
YMin: -1000Max: 1000
designOptions.signature.textColor
string
Text color
designOptions.signature.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.summary
object
Summary
designOptions.summary.bgColor
string
Bg color
designOptions.summary.bgImage
object
Bg image
designOptions.summary.bgImage.image
object
Image
designOptions.summary.bgImage.image._id
string
ID
designOptions.summary.bgImage.image.extension
string
Extension
designOptions.summary.bgImage.image.group
string
Group
designOptions.summary.bgImage.image.handle
string
Handle
designOptions.summary.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summary.bgImage.image.size
number
Size
designOptions.summary.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summary.bgImage.image.url
string
Url
designOptions.summary.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summary.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summary.bgImage.repeat
boolean
Repeat
designOptions.summary.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summary.border
object
Border
designOptions.summary.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summary.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summary.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.border.right
integer
RightMin: -1000Max: 1000
designOptions.summary.border.top
integer
TopMin: -1000Max: 1000
designOptions.summary.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summary.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summary.borderColor
string
Border color
designOptions.summary.css
string
CssMax: 5000
designOptions.summary.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summary.id
string
IDMin: 1Max: 100
designOptions.summary.margin
object
Margin
designOptions.summary.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summary.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summary.padding
object
Padding
designOptions.summary.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summary.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summary.shadow
object
Shadow
designOptions.summary.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summary.shadow.color
string
Color
designOptions.summary.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summary.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary.textColor
string
Text color
designOptions.summary.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.summaryItems
object
Summary items
designOptions.summaryItems.bgColor
string
Bg color
designOptions.summaryItems.bgImage
object
Bg image
designOptions.summaryItems.bgImage.image
object
Image
designOptions.summaryItems.bgImage.image._id
string
ID
designOptions.summaryItems.bgImage.image.extension
string
Extension
designOptions.summaryItems.bgImage.image.group
string
Group
designOptions.summaryItems.bgImage.image.handle
string
Handle
designOptions.summaryItems.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summaryItems.bgImage.image.size
number
Size
designOptions.summaryItems.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summaryItems.bgImage.image.url
string
Url
designOptions.summaryItems.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summaryItems.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summaryItems.bgImage.repeat
boolean
Repeat
designOptions.summaryItems.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summaryItems.border
object
Border
designOptions.summaryItems.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summaryItems.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.border.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.border.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summaryItems.borderColor
string
Border color
designOptions.summaryItems.css
string
CssMax: 5000
designOptions.summaryItems.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summaryItems.id
string
IDMin: 1Max: 100
designOptions.summaryItems.margin
object
Margin
designOptions.summaryItems.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.padding
object
Padding
designOptions.summaryItems.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.shadow
object
Shadow
designOptions.summaryItems.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summaryItems.shadow.color
string
Color
designOptions.summaryItems.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summaryItems.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summaryItems.textColor
string
Text color
designOptions.summaryItems.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
dueDate
date
Deadline for this record.
dueDateTemplate
number
Formula for calculating the due date automatically.Min: 0
inheritLocale
boolean
Use the workspace language instead of a custom one.
isArchived
boolean
This record has been archived and is hidden from main views.
isAutoInvoicePaid
boolean
This auto-generated invoice has been paid.
isDiscountBeforeTax
boolean
Apply the discount to the subtotal before calculating tax.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
issueDate
date
The date printed on this invoice as the issue date.
issueDateTemplate
number
Formula for calculating the issue date automatically.Min: 0
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
name
string
Display name.Min: 1Max: 500
nameSortKey
string
Lowercase normalized version of name used for sorting.
paymentOptions
array
Payment methods the client can use to pay this invoice.
paymentOptions.$
string
Payment options
pendingAt
date
When this record entered a pending state.
projectId
string
ID of the project this record belongs to.
projectTemplateId
string
Project template used to create this project.
proposalId
string
ID of the proposal linked to this record.
schedulerId
string
ID of the linked booking page.
signature
object
Electronic signature captured on this document.
signature._id
string
ID
signature.deviceInfo
object
Device info
signature.deviceInfo.IP
string
Ip
signature.deviceInfo.browser
string
Browser
signature.entityId
string
Entity ID
signature.entityType
string
Entity typeAllowed: company, person
signature.name
string
NameMin: 2
signature.signature
string
SignatureMax: 20000
signature.signedAt
date
Signed at
splitInvoiceOptions
array
How this invoice is divided into instalment payments.Min: 2Max: 5
splitInvoiceOptions.$
object
Split invoice options
splitInvoiceOptions.$._id
string
ID
splitInvoiceOptions.$.amount
number
AmountMin: 0
splitInvoiceOptions.$.dueDate
date
Due date
splitInvoiceOptions.$.dueDateTemplate
number
Due date template
splitInvoiceOptions.$.value
string
Value
status
string
Current status of this record. Values vary by resource.
subTotal
number
Total before tax and discounts.
tax
array
Tax lines applied to this record.
tax.$
object
Tax
tax.$.amount
number
Amount
tax.$.title
string
TitleMax: 100
tax.$.value
number
Value
templateId
string
Template this record was created from.
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create proposal

https://api.plutio.com/v1.11/proposals

Creates a new proposal in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Archive proposal

https://api.plutio.com/v1.11/proposals/archive

Archives this proposal, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive proposal

https://api.plutio.com/v1.11/proposals/bulk/archive

Archives multiple proposals in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update proposal

https://api.plutio.com/v1.11/proposals

Updates the fields of an existing proposal. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update proposal

https://api.plutio.com/v1.11/proposals/bulk

Updates multiple proposals in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get proposal

https://api.plutio.com/v1.11/proposals

Returns a list of all proposals in your workspace.

DELETE

Delete proposal

https://api.plutio.com/v1.11/proposals

Permanently deletes this proposal from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete proposal

https://api.plutio.com/v1.11/proposals/bulk

Permanently deletes multiple proposals in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Contracts

Contracts are legally binding agreements that both you and your client sign to formally commit to the scope and terms of a project. Plutio supports electronic signatures so clients can sign directly from a link you send them without any printing or scanning. You can set up multi-signee contracts where multiple people need to sign. The API lets you check signature status, send signature request reminders, and retrieve signed contract data for your records.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
contractId
string
ID of the contract linked to this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section
object
Section
designOptions.section.bgColor
string
Bg color
designOptions.section.bgImage
object
Bg image
designOptions.section.bgImage.image
object
Image
designOptions.section.bgImage.image._id
string
ID
designOptions.section.bgImage.image.extension
string
Extension
designOptions.section.bgImage.image.group
string
Group
designOptions.section.bgImage.image.handle
string
Handle
designOptions.section.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.section.bgImage.image.size
number
Size
designOptions.section.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.section.bgImage.image.url
string
Url
designOptions.section.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.section.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.section.bgImage.repeat
boolean
Repeat
designOptions.section.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.section.border
object
Border
designOptions.section.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.section.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.section.border.left
integer
LeftMin: -1000Max: 1000
designOptions.section.border.right
integer
RightMin: -1000Max: 1000
designOptions.section.border.top
integer
TopMin: -1000Max: 1000
designOptions.section.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.section.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.section.borderColor
string
Border color
designOptions.section.css
string
CssMax: 5000
designOptions.section.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.section.id
string
IDMin: 1Max: 100
designOptions.section.margin
object
Margin
designOptions.section.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.section.margin.right
integer
RightMin: -1000Max: 1000
designOptions.section.margin.top
integer
TopMin: -1000Max: 1000
designOptions.section.padding
object
Padding
designOptions.section.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.section.padding.right
integer
RightMin: -1000Max: 1000
designOptions.section.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section.shadow
object
Shadow
designOptions.section.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.section.shadow.color
string
Color
designOptions.section.shadow.x
integer
XMin: -1000Max: 1000
designOptions.section.shadow.y
integer
YMin: -1000Max: 1000
designOptions.section.textColor
string
Text color
designOptions.section.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.signature
object
Signature
designOptions.signature.bgColor
string
Bg color
designOptions.signature.bgImage
object
Bg image
designOptions.signature.bgImage.image
object
Image
designOptions.signature.bgImage.image._id
string
ID
designOptions.signature.bgImage.image.extension
string
Extension
designOptions.signature.bgImage.image.group
string
Group
designOptions.signature.bgImage.image.handle
string
Handle
designOptions.signature.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.signature.bgImage.image.size
number
Size
designOptions.signature.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.signature.bgImage.image.url
string
Url
designOptions.signature.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.signature.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.signature.bgImage.repeat
boolean
Repeat
designOptions.signature.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.signature.border
object
Border
designOptions.signature.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.signature.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.signature.border.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.border.right
integer
RightMin: -1000Max: 1000
designOptions.signature.border.top
integer
TopMin: -1000Max: 1000
designOptions.signature.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.signature.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.signature.borderColor
string
Border color
designOptions.signature.css
string
CssMax: 5000
designOptions.signature.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.signature.id
string
IDMin: 1Max: 100
designOptions.signature.margin
object
Margin
designOptions.signature.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.margin.right
integer
RightMin: -1000Max: 1000
designOptions.signature.margin.top
integer
TopMin: -1000Max: 1000
designOptions.signature.padding
object
Padding
designOptions.signature.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.signature.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.signature.padding.right
integer
RightMin: -1000Max: 1000
designOptions.signature.padding.top
integer
TopMin: -1000Max: 1000
designOptions.signature.shadow
object
Shadow
designOptions.signature.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.signature.shadow.color
string
Color
designOptions.signature.shadow.x
integer
XMin: -1000Max: 1000
designOptions.signature.shadow.y
integer
YMin: -1000Max: 1000
designOptions.signature.textColor
string
Text color
designOptions.signature.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: proposal
inheritLocale
boolean
Use the workspace language instead of a custom one.
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
issueDate
date
The date printed on this invoice as the issue date.
issueDateTemplate
number
Formula for calculating the issue date automatically.Min: 0
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
name
string
Display name.Min: 1Max: 500
nameSortKey
string
Lowercase normalized version of name used for sorting.
projectId
string
ID of the project this record belongs to.
signatures
array
All signatures collected on this document.
signatures.$
object
Signatures
signatures.$._id
string
ID
signatures.$.deviceInfo
object
Device info
signatures.$.deviceInfo.IP
string
Ip
signatures.$.deviceInfo.browser
string
Browser
signatures.$.entityId
string
Entity ID
signatures.$.entityType
string
Entity typeAllowed: company, person
signatures.$.name
string
NameMin: 2
signatures.$.signature
string
SignatureMax: 20000
signatures.$.signedAt
date
Signed at
signees
array
People required to sign this contract.
signees.$
object
Signees
signees.$._id
string
ID
signees.$.entityType
string
Entity typeAllowed: company, person
status
string
Current status of this record. Values vary by resource.Allowed: cancelled, draft, partially_signed, pending, signed
templateId
string
Template this record was created from.
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create contract

https://api.plutio.com/v1.11/contracts

Creates a new contract in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Archive contract

https://api.plutio.com/v1.11/contracts/archive

Archives this contract, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive contract

https://api.plutio.com/v1.11/contracts/bulk/archive

Archives multiple contracts in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update contract

https://api.plutio.com/v1.11/contracts

Updates the fields of an existing contract. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update contract

https://api.plutio.com/v1.11/contracts/bulk

Updates multiple contracts in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get contract

https://api.plutio.com/v1.11/contracts

Returns a list of all contracts in your workspace.

DELETE

Delete contract

https://api.plutio.com/v1.11/contracts

Permanently deletes this contract from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete contract

https://api.plutio.com/v1.11/contracts/bulk

Permanently deletes multiple contracts in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Forms

Forms are fully customizable questionnaires and data collection pages that you can share as a public URL or embed on a website. You might use a form for new client onboarding (collecting company name, project brief, budget, and timeline), project intake requests, customer feedback surveys, or job applications. You define the fields and questions, choose whether the form is public or requires authentication, and when someone submits it the response is stored in Plutio and accessible via the API.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
activationDate
date
Date this form becomes active.
activationDateTemplate
number
Formula used to calculate the activation date.Min: 0
amount
number
The monetary amount for this record.
billableItems
array
Time entries or expenses on this record that can be billed to a client.
billableItems.$
object
Billable items
billableItems.$._id
string
ID
billableItems.$.amount
number
Amount
billableItems.$.attachment
object
Attachment
billableItems.$.attachment._id
string
ID
billableItems.$.attachment.extension
string
Extension
billableItems.$.attachment.group
string
Group
billableItems.$.attachment.handle
string
Handle
billableItems.$.attachment.mimeType
string
Mime typeMax: 256
billableItems.$.attachment.size
number
Size
billableItems.$.attachment.title
string
TitleMin: 1Max: 500
billableItems.$.attachment.url
string
Url
billableItems.$.descriptionHTML
string
Description html
billableItems.$.descriptionPlain
string
Description plainMax: 10000
billableItems.$.discount
string
Discount
billableItems.$.discountAmount
number
Discount amount
billableItems.$.discountPercentage
number
Discount percentage
billableItems.$.hasDescription
boolean
Has description
billableItems.$.quantity
number
QuantityMin: 0
billableItems.$.subTotal
number
Sub total
billableItems.$.tax
number
Tax
billableItems.$.taxAmount
number
Tax amount
billableItems.$.title
string
TitleMax: 500
billableItems.$.totalAmount
number
Total amount
billableItems.$.totalDiscount
number
Total discount
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonBg
string
Button bg
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonText
string
Button text
designOptions.css
string
CssMax: 5000
designOptions.descriptionColor
string
Description color
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.itemCard
object
Item card
designOptions.itemCard.bgColor
string
Bg color
designOptions.itemCard.bgImage
object
Bg image
designOptions.itemCard.bgImage.image
object
Image
designOptions.itemCard.bgImage.image._id
string
ID
designOptions.itemCard.bgImage.image.extension
string
Extension
designOptions.itemCard.bgImage.image.group
string
Group
designOptions.itemCard.bgImage.image.handle
string
Handle
designOptions.itemCard.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.itemCard.bgImage.image.size
number
Size
designOptions.itemCard.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.itemCard.bgImage.image.url
string
Url
designOptions.itemCard.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.itemCard.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.itemCard.bgImage.repeat
boolean
Repeat
designOptions.itemCard.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.itemCard.border
object
Border
designOptions.itemCard.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.itemCard.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.itemCard.border.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.border.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.border.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.itemCard.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.itemCard.borderColor
string
Border color
designOptions.itemCard.css
string
CssMax: 5000
designOptions.itemCard.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.itemCard.id
string
IDMin: 1Max: 100
designOptions.itemCard.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.itemCard.margin
object
Margin
designOptions.itemCard.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.margin.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.margin.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.padding
object
Padding
designOptions.itemCard.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.padding.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.padding.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.shadow
object
Shadow
designOptions.itemCard.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.itemCard.shadow.color
string
Color
designOptions.itemCard.shadow.x
integer
XMin: -1000Max: 1000
designOptions.itemCard.shadow.y
integer
YMin: -1000Max: 1000
designOptions.itemCard.textColor
string
Text color
designOptions.itemCard.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.labelColor
string
Label color
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.pageBgColor
string
Page bg color
designOptions.section
object
Section
designOptions.section.bgColor
string
Bg color
designOptions.section.bgImage
object
Bg image
designOptions.section.bgImage.image
object
Image
designOptions.section.bgImage.image._id
string
ID
designOptions.section.bgImage.image.extension
string
Extension
designOptions.section.bgImage.image.group
string
Group
designOptions.section.bgImage.image.handle
string
Handle
designOptions.section.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.section.bgImage.image.size
number
Size
designOptions.section.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.section.bgImage.image.url
string
Url
designOptions.section.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.section.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.section.bgImage.repeat
boolean
Repeat
designOptions.section.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.section.border
object
Border
designOptions.section.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.section.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.section.border.left
integer
LeftMin: -1000Max: 1000
designOptions.section.border.right
integer
RightMin: -1000Max: 1000
designOptions.section.border.top
integer
TopMin: -1000Max: 1000
designOptions.section.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.section.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.section.borderColor
string
Border color
designOptions.section.css
string
CssMax: 5000
designOptions.section.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.section.id
string
IDMin: 1Max: 100
designOptions.section.margin
object
Margin
designOptions.section.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.section.margin.right
integer
RightMin: -1000Max: 1000
designOptions.section.margin.top
integer
TopMin: -1000Max: 1000
designOptions.section.padding
object
Padding
designOptions.section.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.section.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.section.padding.right
integer
RightMin: -1000Max: 1000
designOptions.section.padding.top
integer
TopMin: -1000Max: 1000
designOptions.section.shadow
object
Shadow
designOptions.section.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.section.shadow.color
string
Color
designOptions.section.shadow.x
integer
XMin: -1000Max: 1000
designOptions.section.shadow.y
integer
YMin: -1000Max: 1000
designOptions.section.textColor
string
Text color
designOptions.section.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary
object
Summary
designOptions.summary.bgColor
string
Bg color
designOptions.summary.bgImage
object
Bg image
designOptions.summary.bgImage.image
object
Image
designOptions.summary.bgImage.image._id
string
ID
designOptions.summary.bgImage.image.extension
string
Extension
designOptions.summary.bgImage.image.group
string
Group
designOptions.summary.bgImage.image.handle
string
Handle
designOptions.summary.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summary.bgImage.image.size
number
Size
designOptions.summary.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summary.bgImage.image.url
string
Url
designOptions.summary.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summary.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summary.bgImage.repeat
boolean
Repeat
designOptions.summary.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summary.border
object
Border
designOptions.summary.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summary.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summary.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.border.right
integer
RightMin: -1000Max: 1000
designOptions.summary.border.top
integer
TopMin: -1000Max: 1000
designOptions.summary.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summary.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summary.borderColor
string
Border color
designOptions.summary.css
string
CssMax: 5000
designOptions.summary.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summary.id
string
IDMin: 1Max: 100
designOptions.summary.margin
object
Margin
designOptions.summary.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summary.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summary.padding
object
Padding
designOptions.summary.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summary.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summary.shadow
object
Shadow
designOptions.summary.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summary.shadow.color
string
Color
designOptions.summary.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summary.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary.textColor
string
Text color
designOptions.summary.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.summaryItems
object
Summary items
designOptions.summaryItems.bgColor
string
Bg color
designOptions.summaryItems.bgImage
object
Bg image
designOptions.summaryItems.bgImage.image
object
Image
designOptions.summaryItems.bgImage.image._id
string
ID
designOptions.summaryItems.bgImage.image.extension
string
Extension
designOptions.summaryItems.bgImage.image.group
string
Group
designOptions.summaryItems.bgImage.image.handle
string
Handle
designOptions.summaryItems.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summaryItems.bgImage.image.size
number
Size
designOptions.summaryItems.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summaryItems.bgImage.image.url
string
Url
designOptions.summaryItems.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summaryItems.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summaryItems.bgImage.repeat
boolean
Repeat
designOptions.summaryItems.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summaryItems.border
object
Border
designOptions.summaryItems.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summaryItems.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.border.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.border.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summaryItems.borderColor
string
Border color
designOptions.summaryItems.css
string
CssMax: 5000
designOptions.summaryItems.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summaryItems.id
string
IDMin: 1Max: 100
designOptions.summaryItems.margin
object
Margin
designOptions.summaryItems.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.padding
object
Padding
designOptions.summaryItems.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.shadow
object
Shadow
designOptions.summaryItems.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summaryItems.shadow.color
string
Color
designOptions.summaryItems.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summaryItems.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summaryItems.textColor
string
Text color
designOptions.summaryItems.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: project
expirationDate
date
Date this record or link expires.
expirationDateTemplate
number
Formula for calculating the expiration date.Min: 0
formId
string
ID of the form linked to this record.
inheritLocale
boolean
Use the workspace language instead of a custom one.
isArchived
boolean
This record has been archived and is hidden from main views.
isDiscountBeforeTax
boolean
Apply the discount to the subtotal before calculating tax.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
locale
object
Language code (e.g. en, fr, de, es).
locale.currencyFormat
string
Currency formatAllowed: $ 100,000.00, $ 100.000,00, $1,00,000.00, $100,000.00, $100.000,00, 100 000,00 $, 100 000,00 $US, 100 000,00 US$, 100 000,00 USD, 100.000,00 $, 100.000,00 US$, 100.000,00 USD, 100000,00 щ.д., 100 000,00 $US, US$ 100.000,00, US$100,000.00, US$100.000,00, USD 100 000,00, USD 100.000,00, USD100,000.00, ١٠٠٬٠٠٠٫٠٠ US$, ১,০০,০০০.০০ US$, ‏100,000.00 $
locale.dateFormat
string
Date formatAllowed: M-d-yyyy, M-dd-yyyy, M/d/yy, M/d/yyyy, M/dd/yyyy, MM-d-yyyy, MM-dd-yyyy, MM/d/yyyy, MM/dd/yyyy, MMM d, yyyy, MMM dd, yyyy, MMM-dd-yyyy, MMMM d, yyyy, MMMM dd, yyyy, MMMM-dd-yyyy, MMMddyyyy, MMddyyyy, d MMM, yyyy, d MMMM, yyyy, d-M-yyyy, d-MM-yyyy, d/M/yyyy, d/MM/yyyy, dd MMM, yyyy, dd MMMM, yyyy, dd-M-yyyy, dd-MM-yy, dd-MM-yyyy, dd-MMM-yyyy, dd-MMMM-yyyy, dd.MM.yyyy, dd/M/yyyy, dd/MM/yy, dd/MM/yyyy, ddMMMyyyy, ddMMyyyy, ddd/yyyy, yyyy, MMM d, yyyy, MMM dd, yyyy, MMMM d, yyyy, MMMM dd, yyyy-M-d, yyyy-M-dd, yyyy-MM-d, yyyy-MM-dd, yyyy-MMM-dd, yyyy-MMMM-dd, yyyy/M/d, yyyy/M/dd, yyyy/MM/d, yyyy/MM/dd, yyyy/ddd, yyyyMMMdd, yyyyMMdd
locale.language
string
LanguageAllowed: ar, bg, cs, da, de, el, en, es, et, fi, fr, he, hi, hu, id, it, ja, lt, lv, nl, no, pl, pt, pt-BR, ro, ru, sk, sl, sr-Latn, sv, th, tl-PH, tr, zh, zh-Hant
locale.timeFormat
string
Time formatAllowed: HH:mm, h:mm a, hh:mm a
locale.timezone
string
TimezoneAllowed: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa
meta
object
System metadata for this record.
meta.latestResponseDate
date
Latest response date
meta.opensCount
number
Opens countMin: 0
meta.responsesCount
number
Responses countMin: 0
nextResponseId
number
Counter used to assign the next form response its ID.Min: 1
notificationOptions
object
Which event notifications are enabled.
notificationOptions.email
object
Email
notificationOptions.email.isEnabled
boolean
Is enabled
notificationOptions.email.time
number
TimeAllowed: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 3, 4, 5, 6, 7, 8, 9
notificationOptions.people
array
People
notificationOptions.people.$
string
People
notificationOptions.push
object
Push
notificationOptions.push.isEnabled
boolean
Is enabled
notificationOptions.push.isInstant
boolean
Is instant
notificationOptions.push.time
number
TimeAllowed: 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 22, 23, 3, 4, 5, 6, 7, 8, 9
paymentOptions
array
Payment methods the client can use to pay this invoice.
paymentOptions.$
string
Payment optionsAllowed: paypal, square, stripe
status
string
Current status of this record. Values vary by resource.Allowed: archived, draft, expired, pending, published
subTotal
number
Total before tax and discounts.
submissionsLimit
number
Cap on how many times this form can be submitted.Min: 1
task
object
Task automatically created when this form is submitted.
task.isEnabled
boolean
Is enabled
task.projectId
string
Project ID
task.taskBoardId
string
Task board ID
task.taskGroupId
string
Task group ID
tax
array
Tax lines applied to this record.
tax.$
object
Tax
tax.$.amount
number
Amount
tax.$.title
string
TitleMax: 100
tax.$.value
number
Value
templateId
string
Template this record was created from.
thankYouPageBlocks
array
Content shown after a form is submitted.
thankYouPageBlocks.$
string
Thank you page blocks
thankYouPageBlocksDesignOptions
object
Design settings for the post-submission page.
thankYouPageBlocksLayout
array
Layout for the post-submission page.
thankYouPageBlocksLayout.$
object
Thank you page blocks layout
thankYouPageBlocksLayout.$._id
string
ID
thankYouPageBlocksLayout.$.blocks
array
Blocks
thankYouPageBlocksLayout.$.blocks.$
string
Blocks
thankYouPageBlocksLayout.$.mobileOrder
array
Mobile order
thankYouPageBlocksLayout.$.mobileOrder.$
string
Mobile order
thankYouPageBlocksLayout.$.settings
object
Settings
thankYouPageBlocksUsage
object
Block types on the post-submission page.
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
welcomePageBlocks
array
Intro content shown before the form starts.
welcomePageBlocks.$
string
Welcome page blocks
welcomePageBlocksDesignOptions
object
Design settings for the form intro page.
welcomePageBlocksLayout
array
Layout for the form intro page.
welcomePageBlocksLayout.$
object
Welcome page blocks layout
welcomePageBlocksLayout.$._id
string
ID
welcomePageBlocksLayout.$.blocks
array
Blocks
welcomePageBlocksLayout.$.blocks.$
string
Blocks
welcomePageBlocksLayout.$.mobileOrder
array
Mobile order
welcomePageBlocksLayout.$.mobileOrder.$
string
Mobile order
welcomePageBlocksLayout.$.settings
object
Settings
welcomePageBlocksUsage
object
Block types on the form intro page.
POST

Create form

https://api.plutio.com/v1.11/forms

Creates a new form in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Copy form

https://api.plutio.com/v1.11/forms/copy

Creates a full copy of this form, duplicating all its content and settings.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
POST

Archive form

https://api.plutio.com/v1.11/forms/archive

Archives this form, removing it from your main views while keeping all its data intact. You can restore it at any time from the Archive.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
POST

Bulk archive form

https://api.plutio.com/v1.11/forms/bulk/archive

Archives multiple forms in a single request. Pass an array of IDs in the request body.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
isArchived
boolean
This record has been archived and is hidden from main views.
PUT

Update form

https://api.plutio.com/v1.11/forms

Updates the fields of an existing form. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update form

https://api.plutio.com/v1.11/forms/bulk

Updates multiple forms in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get form

https://api.plutio.com/v1.11/forms

Returns a list of all forms in your workspace.

DELETE

Delete form

https://api.plutio.com/v1.11/forms

Permanently deletes this form from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete form

https://api.plutio.com/v1.11/forms/bulk

Permanently deletes multiple forms in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Form Responses

Form Responses are the submitted entries from a form. Each response contains all the answers the person provided along with the timestamp of when they submitted it and any other metadata. For example if you have an onboarding form with 12 questions, each time a new client fills it out a form response is created with all 12 answers stored. You can retrieve responses via the API to process them in your own system, trigger automated workflows, or export them for analysis.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
amount
number
The monetary amount for this record.
billableItems
array
Time entries or expenses on this record that can be billed to a client.
billableItems.$
object
Billable items
billableItems.$._id
string
ID
billableItems.$.amount
number
Amount
billableItems.$.attachment
object
Attachment
billableItems.$.attachment._id
string
ID
billableItems.$.attachment.extension
string
Extension
billableItems.$.attachment.group
string
Group
billableItems.$.attachment.handle
string
Handle
billableItems.$.attachment.mimeType
string
Mime typeMax: 256
billableItems.$.attachment.size
number
Size
billableItems.$.attachment.title
string
TitleMin: 1Max: 500
billableItems.$.attachment.url
string
Url
billableItems.$.descriptionHTML
string
Description html
billableItems.$.descriptionPlain
string
Description plainMax: 10000
billableItems.$.discount
string
Discount
billableItems.$.discountAmount
number
Discount amount
billableItems.$.discountPercentage
number
Discount percentage
billableItems.$.hasDescription
boolean
Has description
billableItems.$.quantity
number
QuantityMin: 0
billableItems.$.subTotal
number
Sub total
billableItems.$.tax
number
Tax
billableItems.$.taxAmount
number
Tax amount
billableItems.$.title
string
TitleMax: 500
billableItems.$.totalAmount
number
Total amount
billableItems.$.totalDiscount
number
Total discount
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
currency
string
Three-letter ISO currency code (e.g. USD, EUR, GBP).Allowed: AED, AFN, ALL, AMD, ARS, AUD, AZN, BAM, BDT, BGN, BHD, BIF, BND, BOB, BRL, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HRK, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KHR, KMF, KRW, KWD, KZT, LAK, LBP, LKR, LYD, MAD, MDL, MGA, MKD, MMK, MOP, MUR, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SDG, SEK, SGD, SOS, SYP, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, XAF, XOF, XPF, YER, ZAR, ZMK
data
object
Submitted form response data, a key-value object mapping field IDs to their submitted answers.
discount
string
Discount applied to this record.
email
string
Email address.
formId
string
ID of the form linked to this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isDiscountBeforeTax
boolean
Apply the discount to the subtotal before calculating tax.
isPendingPayment
boolean
Payment has been initiated but not yet confirmed.
isStarred
boolean
Starred for quick access.
name
string
Display name.
notes
string
Free-form notes attached to this record.Max: 5000
paymentId
string
ID of the associated payment transaction.
paymentMethod
object
Payment method details for this record.
paymentMethod._id
string
ID
paymentMethod.customerId
string
Customer ID
paymentMethod.meta
object
Meta
paymentMethod.meta.cardLast4
string
Card last4
paymentMethod.meta.cardType
string
Card type
paymentMethod.option
string
Option
responseId
string
ID of the form response linked to this record.
subTotal
number
Total before tax and discounts.
tax
array
Tax lines applied to this record.
tax.$
object
Tax
tax.$.amount
number
Amount
tax.$.title
string
TitleMax: 100
tax.$.value
number
Value
tempFormId
string
Temporary ID used while the form is being drafted.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create form response

https://api.plutio.com/v1.11/form-responses

Creates a new form response in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update form response

https://api.plutio.com/v1.11/form-responses

Updates the fields of an existing form response. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get form response

https://api.plutio.com/v1.11/form-responses

Returns a list of all form responses in your workspace.

DELETE

Delete form response

https://api.plutio.com/v1.11/form-responses

Permanently deletes this form response from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete form response

https://api.plutio.com/v1.11/form-responses/bulk

Permanently deletes multiple form responses in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Templates

Templates let you save and reuse complete document and project structures so you never have to start from scratch. You can create a template for a project (with predefined tasks and boards already set up), an invoice (with your standard line items and payment terms), a proposal (with your usual pricing table and scope sections), a contract (with standard legal clauses), a form, and more. When you create a new item from a template all the content is pre-filled and ready to customize for the specific client or project.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
assets
object
Files or media attached to this record.
autoFillTitle
boolean
Auto-populate the title based on related data when true.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
description
string
Optional text description.Max: 1000
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: block, blocks-group, contract, dashboard-page, form, invoice, item, project, proposal, receipt, scheduler, task, task-board, task-group
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isOfficial
boolean
Built-in Plutio record (e.g. a default template), not user-created.
isPublic
boolean
Accessible to anyone without needing to log in.
likes
array
Profile IDs of people who liked this.
likes.$
string
Likes
likesCount
integer
Total like count.Min: 0
shareSettings
object
Controls who can view this via a shared link.
shareSettings.assets
array
Assets
shareSettings.assets.$
string
AssetsAllowed: custom-field
shareSettings.method
string
MethodAllowed: off, view, view_add
title
string
Display name for this record.Min: 1Max: 250
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create template

https://api.plutio.com/v1.11/templates

Creates a new template in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityType
string
Resource type this item is attached to.Allowed: block, blocks-group, contract, dashboard-page, form, invoice, item, project, proposal, receipt, scheduler, task, task-board, task-group
PUT

Update template

https://api.plutio.com/v1.11/templates

Updates the fields of an existing template. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get template

https://api.plutio.com/v1.11/templates

Returns a list of all templates in your workspace.

DELETE

Delete template

https://api.plutio.com/v1.11/templates

Permanently deletes this template from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Sections

Sections are the structural containers that make up proposals, contracts, invoices, forms, and other Plutio documents. Each Section holds one or more Blocks arranged in a visual layout of rows and columns. The blocks are the actual content and the section is the container that positions them on the page. You can save a Section as a reusable template so you can insert your standard clauses, pricing tables, or signature blocks into any new document without rebuilding them each time.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
layout
array
Layout configuration for content arrangement.
layout.$
object
Layout
layout.$._id
string
ID
layout.$.height
integer
HeightMin: 1Max: 50
layout.$.width
integer
WidthMin: 1Max: 24
layout.$.x
integer
XMin: 0Max: 24
layout.$.y
integer
YMin: 0Max: 1000
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
PUT

Update section

https://api.plutio.com/v1.11/block-groups

Updates the fields of an existing section. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get section

https://api.plutio.com/v1.11/block-groups

Returns a list of all sections in your workspace.

Blocks

Blocks are the individual content components that sit inside Sections. Each block is one unit of content like a paragraph of text, a pricing table, an image, a signature field, a terms clause, or a video embed. Blocks do not exist on their own inside a document; they live inside Sections, which provide the structural layout. You define what content goes into a Section by adding and arranging blocks inside it.

Each block type has a different schema.

Generic blocks

content

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
hasText
boolean
Has text
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
textHTML
string
Text html
textPlain
string
Text plainMax: 120000
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

image

Field
Type
Req
Description
_id
string
Unique identifier for this record.
attachment
object
A single file attached to this record.
attachment._id
string
ID
attachment.extension
string
Extension
attachment.group
string
Group
attachment.handle
string
Handle
attachment.mimeType
string
Mime typeMax: 256
attachment.size
number
Size
attachment.title
string
TitleMin: 1Max: 500
attachment.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.image
object
Image
designOptions.image.border
object
Border
designOptions.image.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.image.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.image.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.image.border.left
integer
LeftMin: -1000Max: 1000
designOptions.image.border.right
integer
RightMin: -1000Max: 1000
designOptions.image.border.top
integer
TopMin: -1000Max: 1000
designOptions.image.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.image.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.image.borderColor
string
Border color
designOptions.image.id
string
IDMin: 1Max: 100
designOptions.image.margin
object
Margin
designOptions.image.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.image.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.image.margin.right
integer
RightMin: -1000Max: 1000
designOptions.image.margin.top
integer
TopMin: -1000Max: 1000
designOptions.image.padding
object
Padding
designOptions.image.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.image.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.image.padding.right
integer
RightMin: -1000Max: 1000
designOptions.image.padding.top
integer
TopMin: -1000Max: 1000
designOptions.image.shadow
object
Shadow
designOptions.image.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.image.shadow.color
string
Color
designOptions.image.shadow.x
integer
XMin: -1000Max: 1000
designOptions.image.shadow.y
integer
YMin: -1000Max: 1000
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

canvas

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
previewImage
object
Preview image
previewImage._id
string
ID
previewImage.extension
string
Extension
previewImage.group
string
Group
previewImage.handle
string
Handle
previewImage.mimeType
string
Mime typeMax: 256
previewImage.size
number
Size
previewImage.title
string
TitleMin: 1Max: 500
previewImage.url
string
Url
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
value
string
ValueMax: 200000

video

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
value
string
Value

html

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
value
string
ValueMax: 200000

Proposal blocks

items

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
canSelectMultiple
boolean
Can select multiple
canToggleItems
boolean
Can toggle items
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonSelected
object
Button selected
designOptions.buttonSelected.bgColor
string
Bg color
designOptions.buttonSelected.bgImage
object
Bg image
designOptions.buttonSelected.bgImage.image
object
Image
designOptions.buttonSelected.bgImage.image._id
string
ID
designOptions.buttonSelected.bgImage.image.extension
string
Extension
designOptions.buttonSelected.bgImage.image.group
string
Group
designOptions.buttonSelected.bgImage.image.handle
string
Handle
designOptions.buttonSelected.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonSelected.bgImage.image.size
number
Size
designOptions.buttonSelected.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonSelected.bgImage.image.url
string
Url
designOptions.buttonSelected.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonSelected.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonSelected.bgImage.repeat
boolean
Repeat
designOptions.buttonSelected.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonSelected.border
object
Border
designOptions.buttonSelected.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonSelected.borderColor
string
Border color
designOptions.buttonSelected.css
string
CssMax: 5000
designOptions.buttonSelected.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonSelected.id
string
IDMin: 1Max: 100
designOptions.buttonSelected.margin
object
Margin
designOptions.buttonSelected.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.padding
object
Padding
designOptions.buttonSelected.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.shadow
object
Shadow
designOptions.buttonSelected.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonSelected.shadow.color
string
Color
designOptions.buttonSelected.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonSelected.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonSelected.textColor
string
Text color
designOptions.buttonSelected.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.itemCard
object
Item card
designOptions.itemCard.bgColor
string
Bg color
designOptions.itemCard.bgImage
object
Bg image
designOptions.itemCard.bgImage.image
object
Image
designOptions.itemCard.bgImage.image._id
string
ID
designOptions.itemCard.bgImage.image.extension
string
Extension
designOptions.itemCard.bgImage.image.group
string
Group
designOptions.itemCard.bgImage.image.handle
string
Handle
designOptions.itemCard.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.itemCard.bgImage.image.size
number
Size
designOptions.itemCard.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.itemCard.bgImage.image.url
string
Url
designOptions.itemCard.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.itemCard.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.itemCard.bgImage.repeat
boolean
Repeat
designOptions.itemCard.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.itemCard.border
object
Border
designOptions.itemCard.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.itemCard.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.itemCard.border.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.border.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.border.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.itemCard.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.itemCard.borderColor
string
Border color
designOptions.itemCard.css
string
CssMax: 5000
designOptions.itemCard.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.itemCard.id
string
IDMin: 1Max: 100
designOptions.itemCard.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.itemCard.margin
object
Margin
designOptions.itemCard.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.margin.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.margin.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.padding
object
Padding
designOptions.itemCard.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.padding.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.padding.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.shadow
object
Shadow
designOptions.itemCard.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.itemCard.shadow.color
string
Color
designOptions.itemCard.shadow.x
integer
XMin: -1000Max: 1000
designOptions.itemCard.shadow.y
integer
YMin: -1000Max: 1000
designOptions.itemCard.textColor
string
Text color
designOptions.itemCard.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isAmountFieldHidden
boolean
Is amount field hidden
isArchived
boolean
This record has been archived and is hidden from main views.
isQuantityFieldHidden
boolean
Is quantity field hidden
isSelectionRequired
boolean
Is selection required
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
items
array
Child items inside this wiki.
items.$
object
Items
items.$._id
string
ID
items.$.amount
number
Amount
items.$.attachment
object
Attachment
items.$.attachment._id
string
ID
items.$.attachment.extension
string
Extension
items.$.attachment.group
string
Group
items.$.attachment.handle
string
Handle
items.$.attachment.mimeType
string
Mime typeMax: 256
items.$.attachment.size
number
Size
items.$.attachment.title
string
TitleMin: 1Max: 500
items.$.attachment.url
string
Url
items.$.descriptionHTML
string
Description html
items.$.descriptionPlain
string
Description plainMax: 10000
items.$.discount
string
Discount
items.$.discountAmount
number
Discount amount
items.$.discountPercentage
number
Discount percentage
items.$.hasDescription
boolean
Has description
items.$.isActive
boolean
Is active
items.$.quantity
number
QuantityMin: 0
items.$.settings
object
Settings
items.$.settings.quantity
object
Quantity
items.$.settings.quantity.canChange
boolean
Can change
items.$.settings.quantity.max
number
MaxMax: 100000
items.$.settings.quantity.min
number
MinMin: 0
items.$.subTotal
number
Sub total
items.$.tax
number
Tax
items.$.taxAmount
number
Tax amount
items.$.title
string
TitleMax: 500
items.$.totalAmount
number
Total amount
items.$.totalDiscount
number
Total discount
quantityMeaning
string
Quantity meaningAllowed: hours, pieces, qty
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
view
string
ViewAllowed: cards, cols, table

fees

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary
object
Summary
designOptions.summary.bgColor
string
Bg color
designOptions.summary.bgImage
object
Bg image
designOptions.summary.bgImage.image
object
Image
designOptions.summary.bgImage.image._id
string
ID
designOptions.summary.bgImage.image.extension
string
Extension
designOptions.summary.bgImage.image.group
string
Group
designOptions.summary.bgImage.image.handle
string
Handle
designOptions.summary.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summary.bgImage.image.size
number
Size
designOptions.summary.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summary.bgImage.image.url
string
Url
designOptions.summary.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summary.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summary.bgImage.repeat
boolean
Repeat
designOptions.summary.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summary.border
object
Border
designOptions.summary.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summary.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summary.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.border.right
integer
RightMin: -1000Max: 1000
designOptions.summary.border.top
integer
TopMin: -1000Max: 1000
designOptions.summary.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summary.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summary.borderColor
string
Border color
designOptions.summary.css
string
CssMax: 5000
designOptions.summary.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summary.id
string
IDMin: 1Max: 100
designOptions.summary.margin
object
Margin
designOptions.summary.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summary.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summary.padding
object
Padding
designOptions.summary.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summary.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summary.shadow
object
Shadow
designOptions.summary.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summary.shadow.color
string
Color
designOptions.summary.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summary.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary.textColor
string
Text color
designOptions.summary.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.summaryItems
object
Summary items
designOptions.summaryItems.bgColor
string
Bg color
designOptions.summaryItems.bgImage
object
Bg image
designOptions.summaryItems.bgImage.image
object
Image
designOptions.summaryItems.bgImage.image._id
string
ID
designOptions.summaryItems.bgImage.image.extension
string
Extension
designOptions.summaryItems.bgImage.image.group
string
Group
designOptions.summaryItems.bgImage.image.handle
string
Handle
designOptions.summaryItems.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summaryItems.bgImage.image.size
number
Size
designOptions.summaryItems.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summaryItems.bgImage.image.url
string
Url
designOptions.summaryItems.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summaryItems.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summaryItems.bgImage.repeat
boolean
Repeat
designOptions.summaryItems.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summaryItems.border
object
Border
designOptions.summaryItems.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summaryItems.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.border.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.border.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summaryItems.borderColor
string
Border color
designOptions.summaryItems.css
string
CssMax: 5000
designOptions.summaryItems.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summaryItems.id
string
IDMin: 1Max: 100
designOptions.summaryItems.margin
object
Margin
designOptions.summaryItems.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.padding
object
Padding
designOptions.summaryItems.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.shadow
object
Shadow
designOptions.summaryItems.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summaryItems.shadow.color
string
Color
designOptions.summaryItems.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summaryItems.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summaryItems.textColor
string
Text color
designOptions.summaryItems.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isItemsTaxesHidden
boolean
Is items taxes hidden
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
showItems
boolean
Show items
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

intro

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.contact
object
Contact
designOptions.contact.bgColor
string
Bg color
designOptions.contact.bgImage
object
Bg image
designOptions.contact.bgImage.image
object
Image
designOptions.contact.bgImage.image._id
string
ID
designOptions.contact.bgImage.image.extension
string
Extension
designOptions.contact.bgImage.image.group
string
Group
designOptions.contact.bgImage.image.handle
string
Handle
designOptions.contact.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.contact.bgImage.image.size
number
Size
designOptions.contact.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.contact.bgImage.image.url
string
Url
designOptions.contact.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.contact.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.contact.bgImage.repeat
boolean
Repeat
designOptions.contact.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.contact.border
object
Border
designOptions.contact.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.contact.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.contact.border.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.border.right
integer
RightMin: -1000Max: 1000
designOptions.contact.border.top
integer
TopMin: -1000Max: 1000
designOptions.contact.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.contact.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.contact.borderColor
string
Border color
designOptions.contact.css
string
CssMax: 5000
designOptions.contact.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.contact.id
string
IDMin: 1Max: 100
designOptions.contact.margin
object
Margin
designOptions.contact.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.margin.right
integer
RightMin: -1000Max: 1000
designOptions.contact.margin.top
integer
TopMin: -1000Max: 1000
designOptions.contact.padding
object
Padding
designOptions.contact.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.padding.right
integer
RightMin: -1000Max: 1000
designOptions.contact.padding.top
integer
TopMin: -1000Max: 1000
designOptions.contact.shadow
object
Shadow
designOptions.contact.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.contact.shadow.color
string
Color
designOptions.contact.shadow.x
integer
XMin: -1000Max: 1000
designOptions.contact.shadow.y
integer
YMin: -1000Max: 1000
designOptions.contact.textColor
string
Text color
designOptions.contact.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
from
object
From
from.hasText
boolean
Has text
from.textHTML
string
Text html
from.textPlain
string
Text plainMax: 120000
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
main
object
Main
main.hasText
boolean
Has text
main.textHTML
string
Text html
main.textPlain
string
Text plainMax: 120000
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
to
object
To
to.hasText
boolean
Has text
to.textHTML
string
Text html
to.textPlain
string
Text plainMax: 120000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

signature

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Invoice blocks

intro

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.contact
object
Contact
designOptions.contact.bgColor
string
Bg color
designOptions.contact.bgImage
object
Bg image
designOptions.contact.bgImage.image
object
Image
designOptions.contact.bgImage.image._id
string
ID
designOptions.contact.bgImage.image.extension
string
Extension
designOptions.contact.bgImage.image.group
string
Group
designOptions.contact.bgImage.image.handle
string
Handle
designOptions.contact.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.contact.bgImage.image.size
number
Size
designOptions.contact.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.contact.bgImage.image.url
string
Url
designOptions.contact.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.contact.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.contact.bgImage.repeat
boolean
Repeat
designOptions.contact.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.contact.border
object
Border
designOptions.contact.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.contact.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.contact.border.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.border.right
integer
RightMin: -1000Max: 1000
designOptions.contact.border.top
integer
TopMin: -1000Max: 1000
designOptions.contact.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.contact.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.contact.borderColor
string
Border color
designOptions.contact.css
string
CssMax: 5000
designOptions.contact.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.contact.id
string
IDMin: 1Max: 100
designOptions.contact.margin
object
Margin
designOptions.contact.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.margin.right
integer
RightMin: -1000Max: 1000
designOptions.contact.margin.top
integer
TopMin: -1000Max: 1000
designOptions.contact.padding
object
Padding
designOptions.contact.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.contact.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.contact.padding.right
integer
RightMin: -1000Max: 1000
designOptions.contact.padding.top
integer
TopMin: -1000Max: 1000
designOptions.contact.shadow
object
Shadow
designOptions.contact.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.contact.shadow.color
string
Color
designOptions.contact.shadow.x
integer
XMin: -1000Max: 1000
designOptions.contact.shadow.y
integer
YMin: -1000Max: 1000
designOptions.contact.textColor
string
Text color
designOptions.contact.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
from
object
From
from.hasText
boolean
Has text
from.textHTML
string
Text html
from.textPlain
string
Text plainMax: 120000
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
main
object
Main
main.hasText
boolean
Has text
main.textHTML
string
Text html
main.textPlain
string
Text plainMax: 120000
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
to
object
To
to.hasText
boolean
Has text
to.textHTML
string
Text html
to.textPlain
string
Text plainMax: 120000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

item

Field
Type
Req
Description
_id
string
Unique identifier for this record.
amount
number
The monetary amount for this record.
attachment
object
A single file attached to this record.
attachment._id
string
ID
attachment.extension
string
Extension
attachment.group
string
Group
attachment.handle
string
Handle
attachment.mimeType
string
Mime typeMax: 256
attachment.size
number
Size
attachment.title
string
TitleMin: 1Max: 500
attachment.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 10000
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
quantity
number
Number of units for this line item.Min: 0
snapshot
object
Snapshot
subTotal
number
Total before tax and discounts.
tax
number
Tax lines applied to this record.
taxAmount
number
Calculated tax total in the invoice currency.
title
string
Display name for this record.Max: 500
totalAmount
number
Final total including tax and after discounts.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

items

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonSelected
object
Button selected
designOptions.buttonSelected.bgColor
string
Bg color
designOptions.buttonSelected.bgImage
object
Bg image
designOptions.buttonSelected.bgImage.image
object
Image
designOptions.buttonSelected.bgImage.image._id
string
ID
designOptions.buttonSelected.bgImage.image.extension
string
Extension
designOptions.buttonSelected.bgImage.image.group
string
Group
designOptions.buttonSelected.bgImage.image.handle
string
Handle
designOptions.buttonSelected.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonSelected.bgImage.image.size
number
Size
designOptions.buttonSelected.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonSelected.bgImage.image.url
string
Url
designOptions.buttonSelected.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonSelected.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonSelected.bgImage.repeat
boolean
Repeat
designOptions.buttonSelected.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonSelected.border
object
Border
designOptions.buttonSelected.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonSelected.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonSelected.borderColor
string
Border color
designOptions.buttonSelected.css
string
CssMax: 5000
designOptions.buttonSelected.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonSelected.id
string
IDMin: 1Max: 100
designOptions.buttonSelected.margin
object
Margin
designOptions.buttonSelected.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.padding
object
Padding
designOptions.buttonSelected.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonSelected.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonSelected.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonSelected.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonSelected.shadow
object
Shadow
designOptions.buttonSelected.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonSelected.shadow.color
string
Color
designOptions.buttonSelected.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonSelected.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonSelected.textColor
string
Text color
designOptions.buttonSelected.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.itemCard
object
Item card
designOptions.itemCard.bgColor
string
Bg color
designOptions.itemCard.bgImage
object
Bg image
designOptions.itemCard.bgImage.image
object
Image
designOptions.itemCard.bgImage.image._id
string
ID
designOptions.itemCard.bgImage.image.extension
string
Extension
designOptions.itemCard.bgImage.image.group
string
Group
designOptions.itemCard.bgImage.image.handle
string
Handle
designOptions.itemCard.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.itemCard.bgImage.image.size
number
Size
designOptions.itemCard.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.itemCard.bgImage.image.url
string
Url
designOptions.itemCard.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.itemCard.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.itemCard.bgImage.repeat
boolean
Repeat
designOptions.itemCard.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.itemCard.border
object
Border
designOptions.itemCard.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.itemCard.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.itemCard.border.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.border.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.border.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.itemCard.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.itemCard.borderColor
string
Border color
designOptions.itemCard.css
string
CssMax: 5000
designOptions.itemCard.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.itemCard.id
string
IDMin: 1Max: 100
designOptions.itemCard.imageSize
string
Image sizeAllowed: large, medium, small
designOptions.itemCard.margin
object
Margin
designOptions.itemCard.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.margin.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.margin.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.padding
object
Padding
designOptions.itemCard.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.itemCard.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.itemCard.padding.right
integer
RightMin: -1000Max: 1000
designOptions.itemCard.padding.top
integer
TopMin: -1000Max: 1000
designOptions.itemCard.shadow
object
Shadow
designOptions.itemCard.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.itemCard.shadow.color
string
Color
designOptions.itemCard.shadow.x
integer
XMin: -1000Max: 1000
designOptions.itemCard.shadow.y
integer
YMin: -1000Max: 1000
designOptions.itemCard.textColor
string
Text color
designOptions.itemCard.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isAmountFieldHidden
boolean
Is amount field hidden
isArchived
boolean
This record has been archived and is hidden from main views.
isQuantityFieldHidden
boolean
Is quantity field hidden
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
items
array
Child items inside this wiki.
items.$
object
Items
items.$._id
string
ID
items.$.amount
number
Amount
items.$.attachment
object
Attachment
items.$.attachment._id
string
ID
items.$.attachment.extension
string
Extension
items.$.attachment.group
string
Group
items.$.attachment.handle
string
Handle
items.$.attachment.mimeType
string
Mime typeMax: 256
items.$.attachment.size
number
Size
items.$.attachment.title
string
TitleMin: 1Max: 500
items.$.attachment.url
string
Url
items.$.descriptionHTML
string
Description html
items.$.descriptionPlain
string
Description plainMax: 10000
items.$.discount
string
Discount
items.$.discountAmount
number
Discount amount
items.$.discountPercentage
number
Discount percentage
items.$.hasDescription
boolean
Has description
items.$.quantity
number
QuantityMin: 0
items.$.subTotal
number
Sub total
items.$.tax
number
Tax
items.$.taxAmount
number
Tax amount
items.$.title
string
TitleMax: 500
items.$.totalAmount
number
Total amount
items.$.totalDiscount
number
Total discount
quantityMeaning
string
Quantity meaningAllowed: hours, pieces, qty
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

time-entries

Field
Type
Req
Description
_id
string
Unique identifier for this record.
amount
number
The monetary amount for this record.
attachment
object
A single file attached to this record.
attachment._id
string
ID
attachment.extension
string
Extension
attachment.group
string
Group
attachment.handle
string
Handle
attachment.mimeType
string
Mime typeMax: 256
attachment.size
number
Size
attachment.title
string
TitleMin: 1Max: 500
attachment.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 10000
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isEndDateFieldHidden
boolean
Is end date field hidden
isMerged
boolean
Is merged
isOldestFirst
boolean
Is oldest first
isRateFieldHidden
boolean
Is rate field hidden
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isStartDateFieldHidden
boolean
Is start date field hidden
isTemplate
boolean
Saved as a reusable template.
isTimeFieldHidden
boolean
Is time field hidden
quantity
number
Number of units for this line item.Min: 0
snapshot
object
Snapshot
subTotal
number
Total before tax and discounts.
tax
number
Tax lines applied to this record.
taxAmount
number
Calculated tax total in the invoice currency.
timeEntries
array
Time entries
timeEntries.$
object
Time entries
timeEntries.$._id
string
ID
timeEntries.$.amount
number
AmountMin: 0
timeEntries.$.rate
number
RateMin: 0
timeEntries.$.startedAt
date
Started at
timeEntries.$.stoppedAt
date
Stopped at
timeEntries.$.time
number
TimeMin: 0
timeEntries.$.title
string
Title
title
string
Display name for this record.Max: 500
totalAmount
number
Final total including tax and after discounts.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

task

Field
Type
Req
Description
_id
string
Unique identifier for this record.
amount
number
The monetary amount for this record.
attachment
object
A single file attached to this record.
attachment._id
string
ID
attachment.extension
string
Extension
attachment.group
string
Group
attachment.handle
string
Handle
attachment.mimeType
string
Mime typeMax: 256
attachment.size
number
Size
attachment.title
string
TitleMin: 1Max: 500
attachment.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 10000
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
quantity
number
Number of units for this line item.Min: 0
snapshot
object
Snapshot
subTotal
number
Total before tax and discounts.
taskId
string
ID of the linked task.
tax
number
Tax lines applied to this record.
taxAmount
number
Calculated tax total in the invoice currency.
title
string
Display name for this record.Max: 500
totalAmount
number
Final total including tax and after discounts.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

summary

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.item
object
Item
designOptions.item.bgColor
string
Bg color
designOptions.item.bgImage
object
Bg image
designOptions.item.bgImage.image
object
Image
designOptions.item.bgImage.image._id
string
ID
designOptions.item.bgImage.image.extension
string
Extension
designOptions.item.bgImage.image.group
string
Group
designOptions.item.bgImage.image.handle
string
Handle
designOptions.item.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.item.bgImage.image.size
number
Size
designOptions.item.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.item.bgImage.image.url
string
Url
designOptions.item.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.item.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.item.bgImage.repeat
boolean
Repeat
designOptions.item.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.item.border
object
Border
designOptions.item.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.item.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.item.border.left
integer
LeftMin: -1000Max: 1000
designOptions.item.border.right
integer
RightMin: -1000Max: 1000
designOptions.item.border.top
integer
TopMin: -1000Max: 1000
designOptions.item.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.item.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.item.borderColor
string
Border color
designOptions.item.css
string
CssMax: 5000
designOptions.item.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.item.id
string
IDMin: 1Max: 100
designOptions.item.margin
object
Margin
designOptions.item.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.item.margin.right
integer
RightMin: -1000Max: 1000
designOptions.item.margin.top
integer
TopMin: -1000Max: 1000
designOptions.item.padding
object
Padding
designOptions.item.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.item.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.item.padding.right
integer
RightMin: -1000Max: 1000
designOptions.item.padding.top
integer
TopMin: -1000Max: 1000
designOptions.item.shadow
object
Shadow
designOptions.item.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.item.shadow.color
string
Color
designOptions.item.shadow.x
integer
XMin: -1000Max: 1000
designOptions.item.shadow.y
integer
YMin: -1000Max: 1000
designOptions.item.textColor
string
Text color
designOptions.item.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary
object
Summary
designOptions.summary.bgColor
string
Bg color
designOptions.summary.bgImage
object
Bg image
designOptions.summary.bgImage.image
object
Image
designOptions.summary.bgImage.image._id
string
ID
designOptions.summary.bgImage.image.extension
string
Extension
designOptions.summary.bgImage.image.group
string
Group
designOptions.summary.bgImage.image.handle
string
Handle
designOptions.summary.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summary.bgImage.image.size
number
Size
designOptions.summary.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summary.bgImage.image.url
string
Url
designOptions.summary.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summary.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summary.bgImage.repeat
boolean
Repeat
designOptions.summary.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summary.border
object
Border
designOptions.summary.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summary.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summary.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.border.right
integer
RightMin: -1000Max: 1000
designOptions.summary.border.top
integer
TopMin: -1000Max: 1000
designOptions.summary.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summary.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summary.borderColor
string
Border color
designOptions.summary.css
string
CssMax: 5000
designOptions.summary.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summary.id
string
IDMin: 1Max: 100
designOptions.summary.margin
object
Margin
designOptions.summary.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summary.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summary.padding
object
Padding
designOptions.summary.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summary.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summary.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summary.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summary.shadow
object
Shadow
designOptions.summary.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summary.shadow.color
string
Color
designOptions.summary.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summary.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summary.textColor
string
Text color
designOptions.summary.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.summaryItems
object
Summary items
designOptions.summaryItems.bgColor
string
Bg color
designOptions.summaryItems.bgImage
object
Bg image
designOptions.summaryItems.bgImage.image
object
Image
designOptions.summaryItems.bgImage.image._id
string
ID
designOptions.summaryItems.bgImage.image.extension
string
Extension
designOptions.summaryItems.bgImage.image.group
string
Group
designOptions.summaryItems.bgImage.image.handle
string
Handle
designOptions.summaryItems.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.summaryItems.bgImage.image.size
number
Size
designOptions.summaryItems.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.summaryItems.bgImage.image.url
string
Url
designOptions.summaryItems.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.summaryItems.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.summaryItems.bgImage.repeat
boolean
Repeat
designOptions.summaryItems.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.summaryItems.border
object
Border
designOptions.summaryItems.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.summaryItems.border.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.border.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.border.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.summaryItems.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.summaryItems.borderColor
string
Border color
designOptions.summaryItems.css
string
CssMax: 5000
designOptions.summaryItems.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.summaryItems.id
string
IDMin: 1Max: 100
designOptions.summaryItems.margin
object
Margin
designOptions.summaryItems.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.margin.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.margin.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.padding
object
Padding
designOptions.summaryItems.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.summaryItems.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.summaryItems.padding.right
integer
RightMin: -1000Max: 1000
designOptions.summaryItems.padding.top
integer
TopMin: -1000Max: 1000
designOptions.summaryItems.shadow
object
Shadow
designOptions.summaryItems.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.summaryItems.shadow.color
string
Color
designOptions.summaryItems.shadow.x
integer
XMin: -1000Max: 1000
designOptions.summaryItems.shadow.y
integer
YMin: -1000Max: 1000
designOptions.summaryItems.textColor
string
Text color
designOptions.summaryItems.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isItemsTaxesHidden
boolean
Is items taxes hidden
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Contract blocks

signature

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Scheduler blocks

form

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

scheduler-calendar

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

scheduler-booked

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.button
object
Button
designOptions.button.bgColor
string
Bg color
designOptions.button.bgImage
object
Bg image
designOptions.button.bgImage.image
object
Image
designOptions.button.bgImage.image._id
string
ID
designOptions.button.bgImage.image.extension
string
Extension
designOptions.button.bgImage.image.group
string
Group
designOptions.button.bgImage.image.handle
string
Handle
designOptions.button.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.button.bgImage.image.size
number
Size
designOptions.button.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.button.bgImage.image.url
string
Url
designOptions.button.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.button.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.button.bgImage.repeat
boolean
Repeat
designOptions.button.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.button.border
object
Border
designOptions.button.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.button.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.button.border.left
integer
LeftMin: -1000Max: 1000
designOptions.button.border.right
integer
RightMin: -1000Max: 1000
designOptions.button.border.top
integer
TopMin: -1000Max: 1000
designOptions.button.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.button.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.button.borderColor
string
Border color
designOptions.button.css
string
CssMax: 5000
designOptions.button.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.button.id
string
IDMin: 1Max: 100
designOptions.button.margin
object
Margin
designOptions.button.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.button.margin.right
integer
RightMin: -1000Max: 1000
designOptions.button.margin.top
integer
TopMin: -1000Max: 1000
designOptions.button.padding
object
Padding
designOptions.button.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.button.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.button.padding.right
integer
RightMin: -1000Max: 1000
designOptions.button.padding.top
integer
TopMin: -1000Max: 1000
designOptions.button.shadow
object
Shadow
designOptions.button.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.button.shadow.color
string
Color
designOptions.button.shadow.x
integer
XMin: -1000Max: 1000
designOptions.button.shadow.y
integer
YMin: -1000Max: 1000
designOptions.button.textColor
string
Text color
designOptions.button.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.buttonHover
object
Button hover
designOptions.buttonHover.bgColor
string
Bg color
designOptions.buttonHover.bgImage
object
Bg image
designOptions.buttonHover.bgImage.image
object
Image
designOptions.buttonHover.bgImage.image._id
string
ID
designOptions.buttonHover.bgImage.image.extension
string
Extension
designOptions.buttonHover.bgImage.image.group
string
Group
designOptions.buttonHover.bgImage.image.handle
string
Handle
designOptions.buttonHover.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.buttonHover.bgImage.image.size
number
Size
designOptions.buttonHover.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.buttonHover.bgImage.image.url
string
Url
designOptions.buttonHover.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.buttonHover.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.buttonHover.bgImage.repeat
boolean
Repeat
designOptions.buttonHover.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.buttonHover.border
object
Border
designOptions.buttonHover.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.buttonHover.border.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.border.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.border.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.buttonHover.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.buttonHover.borderColor
string
Border color
designOptions.buttonHover.css
string
CssMax: 5000
designOptions.buttonHover.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.buttonHover.id
string
IDMin: 1Max: 100
designOptions.buttonHover.margin
object
Margin
designOptions.buttonHover.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.margin.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.margin.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.padding
object
Padding
designOptions.buttonHover.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.buttonHover.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.buttonHover.padding.right
integer
RightMin: -1000Max: 1000
designOptions.buttonHover.padding.top
integer
TopMin: -1000Max: 1000
designOptions.buttonHover.shadow
object
Shadow
designOptions.buttonHover.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.buttonHover.shadow.color
string
Color
designOptions.buttonHover.shadow.x
integer
XMin: -1000Max: 1000
designOptions.buttonHover.shadow.y
integer
YMin: -1000Max: 1000
designOptions.buttonHover.textColor
string
Text color
designOptions.buttonHover.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.confirmation
object
Confirmation
designOptions.confirmation.bgColor
string
Bg color
designOptions.confirmation.bgImage
object
Bg image
designOptions.confirmation.bgImage.image
object
Image
designOptions.confirmation.bgImage.image._id
string
ID
designOptions.confirmation.bgImage.image.extension
string
Extension
designOptions.confirmation.bgImage.image.group
string
Group
designOptions.confirmation.bgImage.image.handle
string
Handle
designOptions.confirmation.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.confirmation.bgImage.image.size
number
Size
designOptions.confirmation.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.confirmation.bgImage.image.url
string
Url
designOptions.confirmation.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.confirmation.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.confirmation.bgImage.repeat
boolean
Repeat
designOptions.confirmation.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.confirmation.border
object
Border
designOptions.confirmation.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.confirmation.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.confirmation.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.confirmation.border.left
integer
LeftMin: -1000Max: 1000
designOptions.confirmation.border.right
integer
RightMin: -1000Max: 1000
designOptions.confirmation.border.top
integer
TopMin: -1000Max: 1000
designOptions.confirmation.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.confirmation.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.confirmation.borderColor
string
Border color
designOptions.confirmation.css
string
CssMax: 5000
designOptions.confirmation.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.confirmation.id
string
IDMin: 1Max: 100
designOptions.confirmation.margin
object
Margin
designOptions.confirmation.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.confirmation.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.confirmation.margin.right
integer
RightMin: -1000Max: 1000
designOptions.confirmation.margin.top
integer
TopMin: -1000Max: 1000
designOptions.confirmation.padding
object
Padding
designOptions.confirmation.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.confirmation.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.confirmation.padding.right
integer
RightMin: -1000Max: 1000
designOptions.confirmation.padding.top
integer
TopMin: -1000Max: 1000
designOptions.confirmation.shadow
object
Shadow
designOptions.confirmation.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.confirmation.shadow.color
string
Color
designOptions.confirmation.shadow.x
integer
XMin: -1000Max: 1000
designOptions.confirmation.shadow.y
integer
YMin: -1000Max: 1000
designOptions.confirmation.textColor
string
Text color
designOptions.confirmation.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

button

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
text
string
Text
textBack
string
Text back
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Form blocks

form

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

items

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
canSelectMultiple
boolean
Can select multiple
canToggleItems
boolean
Can toggle items
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
description
string
Optional text description.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isAmountFieldHidden
boolean
Is amount field hidden
isArchived
boolean
This record has been archived and is hidden from main views.
isQuantityFieldHidden
boolean
Is quantity field hidden
isSelectionRequired
boolean
Is selection required
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
items
array
Child items inside this wiki.
items.$
object
Items
items.$._id
string
ID
items.$.amount
number
Amount
items.$.attachment
object
Attachment
items.$.attachment._id
string
ID
items.$.attachment.extension
string
Extension
items.$.attachment.group
string
Group
items.$.attachment.handle
string
Handle
items.$.attachment.mimeType
string
Mime typeMax: 256
items.$.attachment.size
number
Size
items.$.attachment.title
string
TitleMin: 1Max: 500
items.$.attachment.url
string
Url
items.$.descriptionHTML
string
Description html
items.$.descriptionPlain
string
Description plainMax: 10000
items.$.discount
string
Discount
items.$.discountAmount
number
Discount amount
items.$.discountPercentage
number
Discount percentage
items.$.hasDescription
boolean
Has description
items.$.isActive
boolean
Is active
items.$.quantity
number
QuantityMin: 0
items.$.settings
object
Settings
items.$.settings.quantity
object
Quantity
items.$.settings.quantity.canChange
boolean
Can change
items.$.settings.quantity.max
number
MaxMax: 100000
items.$.settings.quantity.min
number
MinMin: 0
items.$.subTotal
number
Sub total
items.$.tax
number
Tax
items.$.taxAmount
number
Tax amount
items.$.title
string
TitleMax: 500
items.$.totalAmount
number
Total amount
items.$.totalDiscount
number
Total discount
quantityMeaning
string
Quantity meaningAllowed: hours, pieces, qty
question
string
Question
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
view
string
ViewAllowed: cards, cols, table

fees

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isItemsTaxesHidden
boolean
Is items taxes hidden
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
showItems
boolean
Show items
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

button

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
text
string
Text
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Wiki blocks

navigation

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.

Wiki page blocks

title

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: blocks-group, contract, dashboard-page, form, invoice, proposal, receipt, scheduler, template, wiki, wiki-page
group
string
Grouping category for this record.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
snapshot
object
Snapshot
title
string
Display name for this record.Max: 1000
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.
updatedAt
date
When this record was last modified.
POST

Create block

https://api.plutio.com/v1.11/blocks

Creates a new block in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update block

https://api.plutio.com/v1.11/blocks

Updates the fields of an existing block. Only the fields you include in the body are changed; everything else stays the same.

No required fields for this request. Any fields from the schema above are accepted.

GET

Get block

https://api.plutio.com/v1.11/blocks

Returns a list of all blocks in your workspace.

DELETE

Delete block

https://api.plutio.com/v1.11/blocks

Permanently deletes this block from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Snippets

Snippets are saved message templates that you and your team can insert into conversations with a single click. Instead of typing the same reply over and over, you write it once as a snippet and reuse it whenever you need it. For example you might have snippets for common replies like "Thanks for reaching out, here is our current availability" or "Your invoice is now overdue, please see the payment link below".

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
categoryId
string
ID of the category tag applied to this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 5000
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
title
string
Display name for this record.Min: 1Max: 200
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create snippet

https://api.plutio.com/v1.11/canned-responses

Creates a new snippet in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
descriptionHTML
string
Description as formatted HTML.
title
string
Display name for this record.Min: 1Max: 200
PUT

Update snippet

https://api.plutio.com/v1.11/canned-responses

Updates the fields of an existing snippet. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get snippet

https://api.plutio.com/v1.11/canned-responses

Returns a list of all snippets in your workspace.

DELETE

Delete snippet

https://api.plutio.com/v1.11/canned-responses

Permanently deletes this snippet from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Notes

Notes are free-form rich text documents you can attach to people, companies, or blocks in Plutio. They are great for meeting notes, client briefs, internal documentation, account history, or any information you want to keep close to the relevant context. For example you might add a note to a client's person record with key preferences and account background.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
attachments
array
Files attached to this record.
attachments.$
object
Attachments
attachments.$._id
string
ID
attachments.$.extension
string
Extension
attachments.$.group
string
Group
attachments.$.handle
string
Handle
attachments.$.mimeType
string
Mime typeMax: 256
attachments.$.size
number
Size
attachments.$.title
string
TitleMin: 1Max: 500
attachments.$.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 5000
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: block, company, person
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create note

https://api.plutio.com/v1.11/notes

Creates a new note in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update note

https://api.plutio.com/v1.11/notes

Updates the fields of an existing note. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get note

https://api.plutio.com/v1.11/notes

Returns a list of all notes in your workspace.

DELETE

Delete note

https://api.plutio.com/v1.11/notes

Permanently deletes this note from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Items

Items are your reusable product and service definitions that you use to populate invoices, proposals, and other financial documents. For example you might define items for "Logo Design" at a fixed price of $800, "Monthly SEO Retainer" at $500 per month, or "Development" at an hourly rate of $120. Once you define an item you can quickly add it to any invoice or proposal without re-entering the price and description every time. Items keep your billing consistent and save a lot of manual work.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
amount
number
The monetary amount for this record.
attachment
object
A single file attached to this record.
attachment._id
string
ID
attachment.extension
string
Extension
attachment.group
string
Group
attachment.handle
string
Handle
attachment.mimeType
string
Mime typeMax: 256
attachment.size
number
Size
attachment.title
string
TitleMin: 1Max: 500
attachment.url
string
Url
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
descriptionHTML
string
Description as formatted HTML.
descriptionPlain
string
Description as plain text.Max: 10000
discount
string
Discount applied to this record.
discountAmount
number
Fixed discount value in the invoice currency.
discountPercentage
number
Discount as a percentage of the subtotal.
hasDescription
boolean
True if a description has been set.
isArchived
boolean
This record has been archived and is hidden from main views.
isTemplate
boolean
Saved as a reusable template.
quantity
number
Number of units for this line item.Min: 0
subTotal
number
Total before tax and discounts.
tax
number
Tax lines applied to this record.
taxAmount
number
Calculated tax total in the invoice currency.
title
string
Display name for this record.Max: 500
totalAmount
number
Final total including tax and after discounts.
totalDiscount
number
Combined discount value applied.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create item

https://api.plutio.com/v1.11/items

Creates a new item in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update item

https://api.plutio.com/v1.11/items

Updates the fields of an existing item. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get item

https://api.plutio.com/v1.11/items

Returns a list of all items in your workspace.

DELETE

Delete item

https://api.plutio.com/v1.11/items

Permanently deletes this item from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Wiki

A Wiki is a structured knowledge base inside your Plutio workspace. You might have a wiki for onboarding new team members, a wiki for client-facing documentation on how to use a delivered product, or a wiki for your agency's internal processes and standard operating procedures. Each wiki is a top-level container that holds a collection of pages organized in a hierarchy.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
color
object
Display color for this record.
color.primary
string
Primary
color.primaryText
string
Primary text
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
description
string
Optional text description.Max: 2000
domain
string
Custom domain configured for client-facing pages on this workspace.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: project
index
number
Sort position within its parent list.Min: 0
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
items
array
Child items inside this wiki.
items.$
object
Items
items.$._id
string
ID
items.$.description
string
Description
items.$.icon
object
Icon
items.$.icon._id
string
ID
items.$.icon.extension
string
Extension
items.$.icon.group
string
Group
items.$.icon.handle
string
Handle
items.$.icon.mimeType
string
Mime typeMax: 256
items.$.icon.size
number
Size
items.$.icon.title
string
TitleMin: 1Max: 500
items.$.icon.url
string
Url
items.$.isLocked
boolean
Is locked
items.$.items
array
Items
items.$.items.$
object
Items
items.$.items.$._id
string
ID
items.$.items.$.description
string
Description
items.$.items.$.icon
object
Icon
items.$.items.$.icon._id
string
ID
items.$.items.$.icon.extension
string
Extension
items.$.items.$.icon.group
string
Group
items.$.items.$.icon.handle
string
Handle
items.$.items.$.icon.mimeType
string
Mime typeMax: 256
items.$.items.$.icon.size
number
Size
items.$.items.$.icon.title
string
TitleMin: 1Max: 500
items.$.items.$.icon.url
string
Url
items.$.items.$.isLocked
boolean
Is locked
items.$.items.$.items
array
Items
items.$.items.$.items.$
object
Items
items.$.items.$.items.$._id
string
ID
items.$.items.$.items.$.description
string
Description
items.$.items.$.items.$.icon
object
Icon
items.$.items.$.items.$.icon._id
string
ID
items.$.items.$.items.$.icon.extension
string
Extension
items.$.items.$.items.$.icon.group
string
Group
items.$.items.$.items.$.icon.handle
string
Handle
items.$.items.$.items.$.icon.mimeType
string
Mime typeMax: 256
items.$.items.$.items.$.icon.size
number
Size
items.$.items.$.items.$.icon.title
string
TitleMin: 1Max: 500
items.$.items.$.items.$.icon.url
string
Url
items.$.items.$.items.$.isLocked
boolean
Is locked
items.$.items.$.items.$.items
array
Items
items.$.items.$.items.$.items.$
object
Items
items.$.items.$.items.$.items.$._id
string
ID
items.$.items.$.items.$.items.$.description
string
Description
items.$.items.$.items.$.items.$.icon
object
Icon
items.$.items.$.items.$.items.$.icon._id
string
ID
items.$.items.$.items.$.items.$.icon.extension
string
Extension
items.$.items.$.items.$.items.$.icon.group
string
Group
items.$.items.$.items.$.items.$.icon.handle
string
Handle
items.$.items.$.items.$.items.$.icon.mimeType
string
Mime typeMax: 256
items.$.items.$.items.$.items.$.icon.size
number
Size
items.$.items.$.items.$.items.$.icon.title
string
TitleMin: 1Max: 500
items.$.items.$.items.$.items.$.icon.url
string
Url
items.$.items.$.items.$.items.$.isLocked
boolean
Is locked
items.$.items.$.items.$.items.$.items
array
Items
items.$.items.$.items.$.items.$.items.$
object
Items
items.$.items.$.items.$.items.$.items.$._id
string
ID
items.$.items.$.items.$.items.$.items.$.description
string
Description
items.$.items.$.items.$.items.$.items.$.icon
object
Icon
items.$.items.$.items.$.items.$.items.$.icon._id
string
ID
items.$.items.$.items.$.items.$.items.$.icon.extension
string
Extension
items.$.items.$.items.$.items.$.items.$.icon.group
string
Group
items.$.items.$.items.$.items.$.items.$.icon.handle
string
Handle
items.$.items.$.items.$.items.$.items.$.icon.mimeType
string
Mime typeMax: 256
items.$.items.$.items.$.items.$.items.$.icon.size
number
Size
items.$.items.$.items.$.items.$.items.$.icon.title
string
TitleMin: 1Max: 500
items.$.items.$.items.$.items.$.items.$.icon.url
string
Url
items.$.items.$.items.$.items.$.items.$.isLocked
boolean
Is locked
items.$.items.$.items.$.items.$.items.$.items
array
Items
items.$.items.$.items.$.items.$.items.$.items.$
object
Items
items.$.items.$.items.$.items.$.items.$.items.$._id
string
ID
items.$.items.$.items.$.items.$.items.$.items.$.description
string
Description
items.$.items.$.items.$.items.$.items.$.items.$.icon
object
Icon
items.$.items.$.items.$.items.$.items.$.items.$.icon._id
string
ID
items.$.items.$.items.$.items.$.items.$.items.$.icon.extension
string
Extension
items.$.items.$.items.$.items.$.items.$.items.$.icon.group
string
Group
items.$.items.$.items.$.items.$.items.$.items.$.icon.handle
string
Handle
items.$.items.$.items.$.items.$.items.$.items.$.icon.mimeType
string
Mime typeMax: 256
items.$.items.$.items.$.items.$.items.$.items.$.icon.size
number
Size
items.$.items.$.items.$.items.$.items.$.items.$.icon.title
string
TitleMin: 1Max: 500
items.$.items.$.items.$.items.$.items.$.items.$.icon.url
string
Url
items.$.items.$.items.$.items.$.items.$.items.$.isLocked
boolean
Is locked
items.$.items.$.items.$.items.$.items.$.items.$.parentId
string
Parent ID
items.$.items.$.items.$.items.$.items.$.items.$.status
string
Status
items.$.items.$.items.$.items.$.items.$.items.$.title
string
Title
items.$.items.$.items.$.items.$.items.$.items.$.type
string
Type
items.$.items.$.items.$.items.$.items.$.parentId
string
Parent ID
items.$.items.$.items.$.items.$.items.$.status
string
Status
items.$.items.$.items.$.items.$.items.$.title
string
Title
items.$.items.$.items.$.items.$.items.$.type
string
Type
items.$.items.$.items.$.items.$.parentId
string
Parent ID
items.$.items.$.items.$.items.$.status
string
Status
items.$.items.$.items.$.items.$.title
string
Title
items.$.items.$.items.$.items.$.type
string
Type
items.$.items.$.items.$.parentId
string
Parent ID
items.$.items.$.items.$.status
string
Status
items.$.items.$.items.$.title
string
Title
items.$.items.$.items.$.type
string
Type
items.$.items.$.parentId
string
Parent ID
items.$.items.$.status
string
Status
items.$.items.$.title
string
Title
items.$.items.$.type
string
Type
items.$.parentId
string
Parent ID
items.$.status
string
Status
items.$.title
string
Title
items.$.type
string
Type
logo
object
Logo image data.
logo.favicon
object
Favicon
logo.favicon._id
string
ID
logo.favicon.extension
string
Extension
logo.favicon.group
string
Group
logo.favicon.handle
string
Handle
logo.favicon.mimeType
string
Mime typeMax: 256
logo.favicon.size
number
Size
logo.favicon.title
string
TitleMin: 1Max: 500
logo.favicon.url
string
Url
logo.main
object
Main
logo.main._id
string
ID
logo.main.extension
string
Extension
logo.main.group
string
Group
logo.main.handle
string
Handle
logo.main.mimeType
string
Mime typeMax: 256
logo.main.size
number
Size
logo.main.title
string
TitleMin: 1Max: 500
logo.main.url
string
Url
messengerId
string
ID of the shared inbox linked to this wiki.
meta
object
System metadata for this record.
meta.cover
object
Cover
meta.cover._id
string
ID
meta.cover.extension
string
Extension
meta.cover.group
string
Group
meta.cover.handle
string
Handle
meta.cover.mimeType
string
Mime typeMax: 256
meta.cover.size
number
Size
meta.cover.title
string
TitleMin: 1Max: 500
meta.cover.url
string
Url
meta.description
string
DescriptionMax: 120
meta.title
string
TitleMax: 60
privateShareSettings
object
Who can access this record when private sharing is on.
privateShareSettings.people
array
People
privateShareSettings.people.$
string
People
privateShareSettings.roles
array
Roles
privateShareSettings.roles.$
string
Roles
privateShareSettings.type
string
TypeAllowed: off, people, roles
projectIndex
object
Sort position within the project.
shareSettings
object
Controls who can view this via a shared link.
shareSettings.isShared
boolean
Is shared
shareSettings.slug
string
SlugMin: 2Max: 50
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
title
string
Display name for this record.Min: 1Max: 500
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create wiki

https://api.plutio.com/v1.11/wiki

Creates a new wiki in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1Max: 500
PUT

Update wiki

https://api.plutio.com/v1.11/wiki

Updates the fields of an existing wiki. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get wiki

https://api.plutio.com/v1.11/wiki

Returns a list of all wiki in your workspace.

DELETE

Delete wiki

https://api.plutio.com/v1.11/wiki

Permanently deletes this wiki from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Wiki Pages

Wiki Pages are the individual documents inside a wiki. Each page has a title and rich text content and pages can be nested inside each other to create a tree structure. For example inside an "Onboarding" wiki you might have pages for "Setting up your tools", "Meeting your team", "Your first week checklist", and "Who to contact for what". Pages support full rich text editing including headings, lists, images, code blocks, and embedded content.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
description
string
Optional text description.Max: 2000
icon
object
Icon or emoji chosen for this record.
icon._id
string
ID
icon.extension
string
Extension
icon.group
string
Group
icon.handle
string
Handle
icon.mimeType
string
Mime typeMax: 256
icon.size
number
Size
icon.title
string
TitleMin: 1Max: 500
icon.url
string
Url
isArchived
boolean
This record has been archived and is hidden from main views.
isLegacy
boolean
Created before a major schema update. Some fields may differ from newer records.
isLocked
boolean
This record is locked and cannot be edited.
parentId
string
ID of the parent record.
status
string
Current status of this record. Values vary by resource.Allowed: draft, published
theme
object
Visual theme applied to this document.
theme.colors
array
Colors
theme.colors.$
object
Colors
theme.colors.$.color
string
Color
theme.colors.$.entityId
string
Entity ID
theme.colors.$.entityType
string
Entity type
theme.colors.$.group
string
Group
theme.colors.$.key
string
Key
theme.colors.$.path
string
Path
title
string
Display name for this record.Min: 1Max: 256
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: category, page
updatedAt
date
When this record was last modified.
wikiId
string
ID of the wiki this page belongs to.
POST

Create wiki page

https://api.plutio.com/v1.11/wiki-entities

Creates a new wiki page in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
parentId
string
ID of the parent record.
title
string
Display name for this record.Min: 1Max: 256
type
string
The type of this record. Values vary by resource.Allowed: category, page
wikiId
string
ID of the wiki this page belongs to.
POST

Move wiki page

https://api.plutio.com/v1.11/wiki-entities/move

Moves this wiki page to a different location. Useful for reorganising without having to recreate it.

Required fields:

Field
Type
Req
Description
destinationId
string
Destination ID
position
integer
PositionMin: 0
PUT

Update wiki page

https://api.plutio.com/v1.11/wiki-entities

Updates the fields of an existing wiki page. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get wiki page

https://api.plutio.com/v1.11/wiki-entities

Returns a list of all wiki pages in your workspace.

DELETE

Delete wiki page

https://api.plutio.com/v1.11/wiki-entities

Permanently deletes this wiki page from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Folders

Folders let you organize your files into a structured hierarchy inside the Plutio file manager. You can create folders, nest folders inside each other, and move files between them just like you would on your computer. For example you might have a top-level folder per client, with subfolders for "Contracts", "Designs", "Invoices", and "Assets" inside each one.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
breadcrumb
array
Path showing the parent hierarchy of this item (e.g. Project > Board > Task).
breadcrumb.$
object
Breadcrumb
breadcrumb.$._id
string
ID
breadcrumb.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
breadcrumb.$.title
string
Title
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: person, project
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
parentFolderId
string
The folder this folder is nested inside.
privateShareSettings
object
Who can access this record when private sharing is on.
privateShareSettings.isManualShare
boolean
Is manual share
privateShareSettings.people
array
People
privateShareSettings.people.$
string
People
privateShareSettings.roles
array
Roles
privateShareSettings.roles.$
string
Roles
privateShareSettings.type
string
TypeAllowed: off, people, public, roles
title
string
Display name for this record.Min: 1Max: 100
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create folder

https://api.plutio.com/v1.11/file-folders

Creates a new folder in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1Max: 100
POST

Move folder

https://api.plutio.com/v1.11/file-folders/move

Moves this folder to a different location. Useful for reorganising without having to recreate it.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update folder

https://api.plutio.com/v1.11/file-folders

Updates the fields of an existing folder. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get folder

https://api.plutio.com/v1.11/file-folders

Returns a list of all folders in your workspace.

DELETE

Delete folder

https://api.plutio.com/v1.11/file-folders

Permanently deletes this folder from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Files

Files are all the documents, images, videos, PDFs, and other assets you upload to Plutio. They live in the Plutio file manager and can be organized into folders. You can attach files to tasks, projects, conversations, proposals, and people. Files can be shared with clients via a public link or kept private inside the workspace. The API lets you upload files, move them between folders, attach them to records, and retrieve public sharing URLs.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
_ids
array
Array of IDs used for bulk operations.
_ids.$
string
Ids
breadcrumb
array
Path showing the parent hierarchy of this item (e.g. Project > Board > Task).
breadcrumb.$
object
Breadcrumb
breadcrumb.$._id
string
ID
breadcrumb.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
breadcrumb.$.title
string
Title
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
customFields
array
Values for the custom fields you have defined for this resource type.
customFields.$
object
Custom fields
customFields.$._id
string
ID
customFields.$.type
string
TypeAllowed: checkbox, contact, currency, date, date_range, link, multi, multirange, rating, select, slider, text
customFields.$.value
string
Value
customFields.$.value.$
string
Value
customFields.$.value.$._id
string
ID
customFields.$.value.$.entityType
string
Entity typeAllowed: company, person
customFields.$.value.$.max
number
Max
customFields.$.value.$.min
number
Min
documentBodyHTML
string
Main body content of the document as HTML.
documentBodyPlain
string
Main body content of the document as plain text.Max: 50000
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: person, project, task
extension
string
File extension (e.g. pdf, png, docx).
folderId
string
ID of the folder this file is stored in.
group
string
Grouping category for this record.Allowed: form, messenger
handle
string
URL-safe slug used in shareable links.
hasDocumentBody
boolean
True if document body content exists.
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
link
string
URL for this record.
linkedEntities
array
Other records manually linked to this one.
linkedEntities.$
object
Linked entities
linkedEntities.$.entityId
string
Entity ID
linkedEntities.$.entityType
string
Entity type
mimeType
string
File type (e.g. image/png, application/pdf).Max: 256
pendingTrashBin
array
Pending trash entries for this file.
pendingTrashBin.$
object
Pending trash bin
pendingTrashBin.$.entityId
string
Entity ID
pendingTrashBin.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
pendingTrashBin.$.trashBinId
string
Trash bin ID
size
number
File size in bytes.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: document, file, link
updatedAt
date
When this record was last modified.
url
string
URL for this file or external link.
POST

Create file

https://api.plutio.com/v1.11/files

Creates a new file in your workspace and returns the created record.

No required fields for this request. Any fields from the schema above are accepted.

POST

Move file

https://api.plutio.com/v1.11/files/move

Moves this file to a different location. Useful for reorganising without having to recreate it.

No required fields for this request. Any fields from the schema above are accepted.

PUT

Update file

https://api.plutio.com/v1.11/files

Updates the fields of an existing file. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
PUT

Bulk update file

https://api.plutio.com/v1.11/files/bulk

Updates multiple files in one request. Pass an array of objects each containing an ID and the fields you want to change.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.
GET

Get file

https://api.plutio.com/v1.11/files

Returns a list of all files in your workspace.

DELETE

Delete file

https://api.plutio.com/v1.11/files

Permanently deletes this file from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
DELETE

Bulk delete file

https://api.plutio.com/v1.11/files/bulk

Permanently deletes multiple files in one request by passing an array of IDs.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Conversations

Conversations are real-time message threads between workspace members or between your team and clients. Each conversation has its own message history, file attachments, and participant list. Conversations can be standalone or linked to a specific project, person, or messenger. You might use them for project discussions, client questions, or internal team communication where the context needs to be preserved over time.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
activeDrafts
array
Active message drafts in this conversation.
activeDrafts.$
object
Active drafts
activeDrafts.$.content
string
Content
activeDrafts.$.personId
string
Person ID
activeDrafts.$.sendAt
date
Send at
activeSnoozes
array
Active snooze reminders on this conversation.
activeSnoozes.$
object
Active snoozes
activeSnoozes.$.endDate
date
End date
activeSnoozes.$.personId
string
Person ID
activeSnoozes.$.startDate
date
Start date
announcers
array
Profile IDs of people who can post pinned announcements.
announcers.$
string
Announcers
businessId
string
ID of the workspace this record belongs to.
color
string
Display color for this record.
conversationId
string
ID of the conversation thread linked to this record.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
delegatedBy
string
Profile ID of whoever delegated this conversation.
delegatedTo
string
Profile ID of the person this conversation was delegated to.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: email, messenger, person, project
icon
string
Icon or emoji chosen for this record.
iconImage
object
Custom icon image data.
iconImage._id
string
ID
iconImage.extension
string
Extension
iconImage.group
string
Group
iconImage.handle
string
Handle
iconImage.mimeType
string
Mime typeMax: 256
iconImage.size
number
Size
iconImage.title
string
TitleMin: 1Max: 500
iconImage.url
string
Url
isAnnouncement
boolean
This message is pinned as an announcement for all participants.
isArchived
boolean
This record has been archived and is hidden from main views.
isClosed
boolean
This conversation or record has been closed.
isPrivate
boolean
Only the owner can see this record.
lastMessage
object
The most recent message in this conversation.
lastMessage._id
string
ID
lastMessage.bodyPlain
string
Body plain
lastMessage.createdAt
date
Created at
lastMessage.createdBy
string
Created by
lastMessage.isSeen
boolean
Is seen
memberRoles
array
Role assignments for each member of this workspace.
memberRoles.$
string
Member roles
members
array
Profile IDs of workspace members with access to this record.
members.$
string
Members
searchMeta
object
Indexed fields used to power search on this record.
searchMeta.group
string
Group
searchMeta.membersIndex
string
Members index
seenMessages
object
Tracks which messages in this conversation have been read.
status
object
Current status of this record. Values vary by resource.
status._id
string
ID
status.color
string
Color
status.textColor
string
Text color
status.title
string
TitleMax: 256
status.type
string
TypeAllowed: active, closed, completed, open
title
string
Display name for this record.Max: 500
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: direct, group
updatedAt
date
When this record was last modified.
POST

Create conversation

https://api.plutio.com/v1.11/conversations

Creates a new conversation in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityType
string
Resource type this item is attached to.Allowed: email, messenger, person, project
PUT

Update conversation

https://api.plutio.com/v1.11/conversations

Updates the fields of an existing conversation. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get conversation

https://api.plutio.com/v1.11/conversations

Returns a list of all conversations in your workspace.

DELETE

Delete conversation

https://api.plutio.com/v1.11/conversations

Permanently deletes this conversation from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Messengers

Messengers are shared inboxes that your whole team can access and manage together. Instead of conversations being tied to individual team members, a Messenger lets your entire team see and respond to incoming client messages collectively. You can assign conversations to specific team members, track whether messages have been responded to, and make sure nothing falls through the cracks.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
isActive
boolean
This record is currently enabled and in use.
isArchived
boolean
This record has been archived and is hidden from main views.
isWhitelabeled
boolean
Plutio branding is hidden on client-facing pages.
mail
object
Email address or mail configuration.
mail.imap
object
Imap
mail.imap.address
string
Address
mail.imap.host
string
Host
mail.imap.name
string
NameMax: 150
mail.imap.password
string
Password
mail.imap.port
number
PortMin: 0Max: 65535
mail.imap.replyToNotificationDomain
string
Reply to notification domain
mail.imap.service
string
ServiceAllowed: 126, 163, 1und1, AOL, Bluewin, DebugMail, DynectEmail, Ethereal, FastMail, GandiMail, Gmail, Godaddy, GodaddyAsia, GodaddyEurope, Hotmail, Infomaniak, Mail.ru, Maildev, Mailgun, Mailjet, Mailosaur, Mailtrap, Mandrill, Naver, OhMySMTP, One, OpenMailBox, Outlook365, Postmark, QQ, QQex, SES, SES-EU-WEST-1, SES-US-EAST-1, SES-US-WEST-2, SendCloud, SendGrid, SendPulse, SendinBlue, Sparkpost, Tipimail, Yahoo, Yandex, Zoho, hot.ee, iCloud, mail.ee, qiye.aliyun
mail.imap.useSSL
boolean
Use ssl
mail.imap.username
string
Username
mail.smtp
object
Smtp
mail.smtp.address
string
Address
mail.smtp.host
string
Host
mail.smtp.name
string
NameMax: 150
mail.smtp.password
string
Password
mail.smtp.port
number
PortMin: 0Max: 65535
mail.smtp.replyToNotificationDomain
string
Reply to notification domain
mail.smtp.service
string
ServiceAllowed: 126, 163, 1und1, AOL, Bluewin, DebugMail, DynectEmail, Ethereal, FastMail, GandiMail, Gmail, Godaddy, GodaddyAsia, GodaddyEurope, Hotmail, Infomaniak, Mail.ru, Maildev, Mailgun, Mailjet, Mailosaur, Mailtrap, Mandrill, Naver, OhMySMTP, One, OpenMailBox, Outlook365, Postmark, QQ, QQex, SES, SES-EU-WEST-1, SES-US-EAST-1, SES-US-WEST-2, SendCloud, SendGrid, SendPulse, SendinBlue, Sparkpost, Tipimail, Yahoo, Yandex, Zoho, hot.ee, iCloud, mail.ee, qiye.aliyun
mail.smtp.useSSL
boolean
Use ssl
mail.smtp.username
string
Username
mailboxes
array
Email inboxes connected to this messenger.
mailboxes.$
object
Mailboxes
mailboxes.$._id
string
ID
mailboxes.$.path
string
Path
mailboxes.$.title
string
TitleMin: 1
mailboxes.$.type
string
TypeAllowed: archive, assigned-by-me, assigned-to-me, drafts, inbox, other, sent, snoozed, trash
members
array
Profile IDs of workspace members with access to this record.
members.$
string
Members
messenger
object
Messenger configuration for this inbox group.
messenger.domains
array
DomainsMax: 3
messenger.domains.$
string
DomainsMin: 3
messenger.greetings
array
Greetings
messenger.greetings.$
object
Greetings
messenger.greetings.$.delay
number
DelayMin: 0Max: 1000000
messenger.greetings.$.display
string
DisplayAllowed: business_hours, off, on
messenger.greetings.$.title
string
TitleMin: 1
messenger.iconImage
object
Icon image
messenger.iconImage._id
string
ID
messenger.iconImage.extension
string
Extension
messenger.iconImage.group
string
Group
messenger.iconImage.handle
string
Handle
messenger.iconImage.mimeType
string
Mime typeMax: 256
messenger.iconImage.size
number
Size
messenger.iconImage.title
string
TitleMin: 1Max: 500
messenger.iconImage.url
string
Url
messenger.position
string
PositionAllowed: left, right
messenger.primaryBg
string
Primary bg
messenger.primaryText
string
Primary text
messenger.secondaryBg
string
Secondary bg
messenger.secondaryText
string
Secondary text
messenger.strings
object
Strings
messenger.strings.away
string
AwayMin: 1
messenger.strings.formPlaceholder
string
Form placeholderMin: 1
messenger.strings.header
string
HeaderMin: 1
messenger.strings.send
string
SendMin: 1
messenger.strings.unknownUserEmail
string
Unknown user emailMin: 1
messenger.strings.unknownUserFinish
string
Unknown user finishMin: 1
messenger.strings.unknownUserName
string
Unknown user nameMin: 1
messenger.workingHours
array
Working hoursMin: 7Max: 7
messenger.workingHours.$
object
Working hours
messenger.workingHours.$.endTime
string
End time
messenger.workingHours.$.isActive
boolean
Is active
messenger.workingHours.$.startTime
string
Start time
title
string
Display name for this record.Min: 1Max: 200
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
type
string
The type of this record. Values vary by resource.Allowed: email, messenger
updatedAt
date
When this record was last modified.
POST

Create messenger

https://api.plutio.com/v1.11/inbox-groups

Creates a new messenger in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
title
string
Display name for this record.Min: 1Max: 200
type
string
The type of this record. Values vary by resource.Allowed: email, messenger
PUT

Update messenger

https://api.plutio.com/v1.11/inbox-groups

Updates the fields of an existing messenger. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get messenger

https://api.plutio.com/v1.11/inbox-groups

Returns a list of all messengers in your workspace.

DELETE

Delete messenger

https://api.plutio.com/v1.11/inbox-groups

Permanently deletes this messenger from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Comments

Comments are messages attached directly to a specific item like a task, a file, or a conversation. Unlike conversations which are standalone threads, comments always live in context. For example you might comment on a task to ask a clarifying question, or comment on a design file to give feedback on a specific version. Comments support mentions so you can notify specific team members, as well as rich text formatting and reactions.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
attachments
array
Files attached to this record.
attachments.$
object
Attachments
attachments.$._id
string
ID
attachments.$.extension
string
Extension
attachments.$.group
string
Group
attachments.$.handle
string
Handle
attachments.$.mimeType
string
Mime typeMax: 256
attachments.$.size
number
Size
attachments.$.title
string
TitleMin: 1Max: 500
attachments.$.url
string
Url
bodyHTML
string
Message or comment body as formatted HTML.
bodyPlain
string
Message or comment body as plain text.Max: 10000
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: conversation, file, task
hasBody
boolean
True if a message body has been written.
isArchived
boolean
This record has been archived and is hidden from main views.
isAuthorExternal
boolean
The author is a client or guest, not a team member.
isNote
boolean
This message is an internal note, not sent to the client.
mentions
array
People tagged in this message or comment.
mentions.$
string
Mentions
reactions
array
Emoji reactions left on this message.
reactions.$
object
Reactions
reactions.$.createdAt
date
Created at
reactions.$.createdBy
string
Created by
reactions.$.reaction
string
Reaction
reactions.$.updatedAt
date
Updated at
repliedTo
string
The message this is a reply to.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create comment

https://api.plutio.com/v1.11/comments

Creates a new comment in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: conversation, file, task
PUT

Update comment

https://api.plutio.com/v1.11/comments

Updates the fields of an existing comment. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get comment

https://api.plutio.com/v1.11/comments

Returns a list of all comments in your workspace.

DELETE

Delete comment

https://api.plutio.com/v1.11/comments

Permanently deletes this comment from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Dashboards

Dashboards are customizable reporting views where you bring together key data from across your workspace into one place. You might build a dashboard that shows your total revenue this month, all open invoices, tasks due this week, and hours logged by your team. Each dashboard is made up of one or more pages and each page contains data widgets you configure to show exactly the metrics you care about most.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
isArchived
boolean
This record has been archived and is hidden from main views.
pages
array
Pages inside this dashboard.
pages.$
object
Pages
pages.$._id
string
ID
pages.$.title
string
TitleMax: 500
title
string
Display name for this record.Min: 2Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
PUT

Update dashboard

https://api.plutio.com/v1.11/dashboards

Updates the fields of an existing dashboard. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get dashboard

https://api.plutio.com/v1.11/dashboards

Returns a list of all dashboards in your workspace.

Dashboard Pages

Dashboard pages are the individual sections that make up a dashboard. You might have separate pages for "Financial Overview", "Project Status", and "Team Performance" within the same dashboard. Each page has its own layout of widgets so you can organize related metrics together and keep your dashboard clean and easy to navigate. You can switch between pages without leaving the dashboard.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
blocks
array
IDs of the Block records that make up this document or section.
blocks.$
string
Blocks
blocksDesignOptions
object
Font, color, and spacing settings applied to this document.
blocksLayout
array
The order and row arrangement of content blocks.
blocksLayout.$
object
Blocks layout
blocksLayout.$._id
string
ID
blocksLayout.$.blocks
array
Blocks
blocksLayout.$.blocks.$
string
Blocks
blocksLayout.$.mobileOrder
array
Mobile order
blocksLayout.$.mobileOrder.$
string
Mobile order
blocksLayout.$.settings
object
Settings
blocksUsage
object
Which block types (text, image, table, etc.) appear in this document.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
dashboardId
string
ID of the parent dashboard.
designOptions
object
Visual design settings (colors, fonts, layout) for this item.
designOptions.bgColor
string
Bg color
designOptions.bgImage
object
Bg image
designOptions.bgImage.image
object
Image
designOptions.bgImage.image._id
string
ID
designOptions.bgImage.image.extension
string
Extension
designOptions.bgImage.image.group
string
Group
designOptions.bgImage.image.handle
string
Handle
designOptions.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.bgImage.image.size
number
Size
designOptions.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.bgImage.image.url
string
Url
designOptions.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.bgImage.repeat
boolean
Repeat
designOptions.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block
object
Block
designOptions.block.bgColor
string
Bg color
designOptions.block.bgImage
object
Bg image
designOptions.block.bgImage.image
object
Image
designOptions.block.bgImage.image._id
string
ID
designOptions.block.bgImage.image.extension
string
Extension
designOptions.block.bgImage.image.group
string
Group
designOptions.block.bgImage.image.handle
string
Handle
designOptions.block.bgImage.image.mimeType
string
Mime typeMax: 256
designOptions.block.bgImage.image.size
number
Size
designOptions.block.bgImage.image.title
string
TitleMin: 1Max: 500
designOptions.block.bgImage.image.url
string
Url
designOptions.block.bgImage.opacity
number
OpacityMin: 0Max: 1
designOptions.block.bgImage.position
string
PositionAllowed: bottom, bottom left, bottom right, center, left, right, top, top left, top right
designOptions.block.bgImage.repeat
boolean
Repeat
designOptions.block.bgImage.size
string
SizeAllowed: auto, contain, cover
designOptions.block.border
object
Border
designOptions.block.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.block.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.block.border.left
integer
LeftMin: -1000Max: 1000
designOptions.block.border.right
integer
RightMin: -1000Max: 1000
designOptions.block.border.top
integer
TopMin: -1000Max: 1000
designOptions.block.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.block.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.block.borderColor
string
Border color
designOptions.block.css
string
CssMax: 5000
designOptions.block.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.block.margin
object
Margin
designOptions.block.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.block.margin.right
integer
RightMin: -1000Max: 1000
designOptions.block.margin.top
integer
TopMin: -1000Max: 1000
designOptions.block.padding
object
Padding
designOptions.block.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.block.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.block.padding.right
integer
RightMin: -1000Max: 1000
designOptions.block.padding.top
integer
TopMin: -1000Max: 1000
designOptions.block.shadow
object
Shadow
designOptions.block.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.block.shadow.color
string
Color
designOptions.block.shadow.x
integer
XMin: -1000Max: 1000
designOptions.block.shadow.y
integer
YMin: -1000Max: 1000
designOptions.block.textColor
string
Text color
designOptions.block.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
designOptions.border
object
Border
designOptions.border.bottom
integer
BottomMin: -1000Max: 1000
designOptions.border.bottomLeftRadius
integer
Bottom left radiusMin: -1000Max: 1000
designOptions.border.bottomRightRadius
integer
Bottom right radiusMin: -1000Max: 1000
designOptions.border.left
integer
LeftMin: -1000Max: 1000
designOptions.border.right
integer
RightMin: -1000Max: 1000
designOptions.border.top
integer
TopMin: -1000Max: 1000
designOptions.border.topLeftRadius
integer
Top left radiusMin: -1000Max: 1000
designOptions.border.topRightRadius
integer
Top right radiusMin: -1000Max: 1000
designOptions.borderColor
string
Border color
designOptions.css
string
CssMax: 5000
designOptions.fontFamily
string
Font familyAllowed: Arial, Arial Black, Comic Sans MS, Courier New, Helvetica, Impact, Lucida Console, Lucida Sans Unicode, Roboto, Tahoma, Times New Roman, Trebuchet MS, Verdana
designOptions.id
string
IDMin: 1Max: 100
designOptions.layout
string
LayoutAllowed: centered, fullwidth
designOptions.margin
object
Margin
designOptions.margin.bottom
integer
BottomMin: -1000Max: 1000
designOptions.margin.left
integer
LeftMin: -1000Max: 1000
designOptions.margin.right
integer
RightMin: -1000Max: 1000
designOptions.margin.top
integer
TopMin: -1000Max: 1000
designOptions.maxWidth
integer
Max widthMin: 600Max: 1800
designOptions.padding
object
Padding
designOptions.padding.bottom
integer
BottomMin: -1000Max: 1000
designOptions.padding.left
integer
LeftMin: -1000Max: 1000
designOptions.padding.right
integer
RightMin: -1000Max: 1000
designOptions.padding.top
integer
TopMin: -1000Max: 1000
designOptions.shadow
object
Shadow
designOptions.shadow.blur
integer
BlurMin: 0Max: 1000
designOptions.shadow.color
string
Color
designOptions.shadow.x
integer
XMin: -1000Max: 1000
designOptions.shadow.y
integer
YMin: -1000Max: 1000
designOptions.textColor
string
Text color
designOptions.verticalAlign
string
Vertical alignAllowed: bottom, middle, top
isArchived
boolean
This record has been archived and is hidden from main views.
isSharedPublicly
boolean
A public shareable link has been enabled for this record.
isTemplate
boolean
Saved as a reusable template.
layout
array
Layout configuration for content arrangement.
layout.$
object
Layout
layout.$._id
string
ID
layout.$.height
integer
HeightMin: 1Max: 50
layout.$.width
integer
WidthMin: 1Max: 24
layout.$.x
integer
XMin: 0Max: 24
layout.$.y
integer
YMin: 0Max: 1000
templateId
string
Template this record was created from.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
POST

Create dashboard page

https://api.plutio.com/v1.11/dashboard-pages

Creates a new dashboard page in your workspace and returns the created record.

Required fields:

Field
Type
Req
Description
dashboardId
string
ID of the parent dashboard.
PUT

Update dashboard page

https://api.plutio.com/v1.11/dashboard-pages

Updates the fields of an existing dashboard page. Only the fields you include in the body are changed; everything else stays the same.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.
GET

Get dashboard page

https://api.plutio.com/v1.11/dashboard-pages

Returns a list of all dashboard pages in your workspace.

DELETE

Delete dashboard page

https://api.plutio.com/v1.11/dashboard-pages

Permanently deletes this dashboard page from your workspace. This action cannot be undone.

Required fields:

Field
Type
Req
Description
_id
string
Unique identifier for this record.

Dashboard Data

Dashboard data is the underlying numbers that power the widgets on your dashboard pages. When a widget displays a metric like "Total Revenue This Month: $24,500" or "Open Tasks: 18", those figures come from dashboard data records. You can use this endpoint to fetch those aggregated metrics programmatically, for example to pull your Plutio workspace data into an external reporting tool, a business intelligence platform, or a custom executive summary report.

GET

Get dashboard data

https://api.plutio.com/v1.11/dashboard-data

Returns the aggregated metric values for the widgets on a specific dashboard page.

Archives

The archive is where you put things that are done and no longer active but that you want to keep for reference. When you archive a project, a task, or any other item it disappears from your main views so it does not clutter your workspace, but all the data is still there and fully accessible via the API. Archiving is not the same as deleting. You can bring archived items back at any time.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
dependencies
array
Related records that depend on this item.
dependencies.$
object
Dependencies
dependencies.$.entityId
string
Entity ID
dependencies.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
dependencies.$.isDeleted
boolean
Is deleted
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
isArchived
boolean
This record has been archived and is hidden from main views.
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
GET

Get archive

https://api.plutio.com/v1.11/archive

Returns all archived items across your workspace.

DELETE

Delete archive

https://api.plutio.com/v1.11/archive

Permanently removes one or more items from the archive.

No required fields for this request. Any fields from the schema above are accepted.

DELETE

Bulk delete archive

https://api.plutio.com/v1.11/archive/bulk

Permanently removes one or more items from the archive.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Trash

Trash holds items you have deleted but have not permanently removed yet. If you delete a project or a task by mistake you can find it in the trash and restore it with everything intact. Items stay in the trash until you explicitly empty it or permanently delete individual items. Once something is permanently deleted from the trash it cannot be recovered.

Field
Type
Req
Description
_id
string
Unique identifier for this record.
businessId
string
ID of the workspace this record belongs to.
createdAt
date
When this record was created.
createdBy
string
Profile ID of the person who created this record.
deleteAt
date
Scheduled date for automatic permanent deletion.
dependencies
array
Related records that depend on this item.
dependencies.$
object
Dependencies
dependencies.$.entityId
string
Entity ID
dependencies.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
dependencies.$.isDeleted
boolean
Is deleted
entityId
string
ID of the record this item belongs to.
entityType
string
Resource type this item is attached to.Allowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
isArchived
boolean
This record has been archived and is hidden from main views.
restoreConnections
array
Re-link related records when restoring from the trash.
restoreConnections.$
object
Restore connections
restoreConnections.$.entityId
string
Entity ID
restoreConnections.$.entityType
string
Entity typeAllowed: activity, api-usage, archive, block, blocks-group, bulk, business, calendar, canned-response, category, chat, comment, company, connected-domain, contract, conversation, custom-field, dashboard, dashboard-page, email, event, file, file-folder, form, form-response, inbox-group, invoice, invoice-subscription, item, note, notification, oauth-app, oauth-client, payment, person, profile, project, proposal, receipt, role, schedule, scheduler, scheduler-booking, status, tag, task, task-board, task-group, template, template-library, time-track, transaction, trash-bin, user, wiki, wiki-page
restoreConnections.$.update
object
Update
title
string
Display name for this record.Min: 1Max: 500
titleSortKey
string
Lowercase normalized version of title used for sorting.
trashBinId
string
Reference to the trash entry. Present when this record has been deleted.
updatedAt
date
When this record was last modified.
GET

Get trash

https://api.plutio.com/v1.11/trash-bin

Returns all items currently in the trash that have not been permanently deleted yet.

DELETE

Delete trash

https://api.plutio.com/v1.11/trash-bin

Permanently deletes one or more items from the trash. Once removed here they cannot be recovered.

No required fields for this request. Any fields from the schema above are accepted.

DELETE

Delete all trash

https://api.plutio.com/v1.11/trash-bin/all

Permanently deletes everything in the trash at once. This cannot be undone.

No required fields for this request. Any fields from the schema above are accepted.

DELETE

Bulk delete trash

https://api.plutio.com/v1.11/trash-bin/bulk

Permanently deletes one or more items from the trash. Once removed here they cannot be recovered.

Required fields:

Field
Type
Req
Description
_ids
array
Array of IDs used for bulk operations.

Scroll to an endpoint to see a code example.