API Docs

Display and behavior settings for the proposal (API format, snake_case)

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailobject

Status lifecycle details (subset relevant to list views)

updated_atstring

ISO 8601 timestamp when the proposal was last updated

updated_bynullable ProposalUser

User who last updated the proposal

paginationobject

Example

{
  "data": [
    {
      "created_at": "example-string",
      "created_by": {
        "email": "example-string",
        "id": "example-string",
        "name": "example-string",
        "avatar_url": "example-string"
      },
      "id": "example-string",
      "name": "example-string",
      "status": "DRAFT",
      "updated_at": "example-string",
      "updated_by": {
        "email": "example-string",
        "id": "example-string",
        "name": "example-string",
        "avatar_url": "example-string"
      },
      "archived": true,
      "archived_at": "example-string",
      "cached_totals": {
        "annually": {
          "max": 100,
          "min": 100
        },
        "currency": "example-string",
        "monthly": {
          "max": 100,
          "min": 100
        },
        "once": {
          "max": 100,
          "min": 100
        },
        "quarterly": {
          "max": 100,
          "min": 100
        },
        "updated_at": "example-string"
      },
      "is_starred": true,
      "is_template": true,
      "settings": {
        "avoid_line_item_page_breaks": true,
        "currency": "example-string",
        "disable_proposal_access": true,
        "email_draft": {
          "last_saved": "example-string",
          "message": "example-string",
          "recipients": "example-string",
          "subject": "example-string"
        },
        "expiring_on": "example-string",
        "hide_pdf_download": true,
        "include_modifications_in_line_item_price": true,
        "notifications": {
          "override_account_defaults": true,
          "rules": [
            {}
          ]
        },
        "recipient": {
          "address": "example-string",
          "contact": {
            "email": "example-string",
            "name": "example-string",
            "phone": "example-string"
          },
          "name": "example-string",
          "website": "example-string"
        },
        "signing": {
          "additional_signers": [
            {}
          ],
          "company_signer": "example-string",
          "custom_company_signer_email": "example-string",
          "custom_company_signer_name": "example-string",
          "is_contact_signer": true,
          "is_multiple_signers": true,
          "override_signature_page_defaults": true,
          "recipient_signer": {
            "email": "example-string",
            "full_name": "example-string"
          },
          "signature_page_agreement_text": "example-string",
          "signature_page_client_label": "example-string",
          "signature_page_company_label": "example-string",
          "use_accept": true
        }
      },
      "status_detail": {
        "marked_as_won_method": "manual"
      }
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals

CreateProposal

Create a new proposal for the user's organization

Request Body

namestringrequired

Proposal name (required)

templateIdstring

Template ID to duplicate from

pagesarray of object

Pages array (for duplication, empty array prevents default page creation)

integrationsnullable ProposalIntegrationsInput

External integrations (write model — payment has settings only, no transactions)

Display and behavior settings for the proposal (API format, snake_case)

Visual design settings for the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

is_templateboolean

Whether this proposal is a reusable template

Example

{
  "name": "example-string",
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      }
    }
  },
  "is_template": true,
  "pages": [
    {
      "name": "example-string",
      "children": [
        {
          "displayCost": "show_all",
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "kind": "group",
          "lineItems": [],
          "name": "example-string",
          "selectionType": "single",
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "hideQuantities": true,
          "in_library": true,
          "is_archived": true,
          "linkedScopeId": "example-string",
          "order_key": 100,
          "quantity": {},
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "updated_at": "example-string"
        }
      ],
      "content": "example-string",
      "designSettings": {
        "backgroundAttachment": "example-string",
        "backgroundColor": "example-string",
        "backgroundImage": "example-string",
        "backgroundOpacity": 100,
        "backgroundPosition": "example-string",
        "backgroundRepeat": "example-string",
        "backgroundSize": "example-string",
        "fontColor": "example-string"
      },
      "discounts": [
        {
          "amount": "example-string",
          "frequency": "example-string",
          "id": "example-string",
          "type": "fixed"
        }
      ],
      "displayHeading": true,
      "excludeFromPdf": true,
      "hideSection": true,
      "hideTotalsBottom": true,
      "hideTotalsTop": true,
      "isScopeOfWork": true,
      "isSignaturesPage": true,
      "kind": "example-string",
      "labels": {
        "tax": "example-string"
      },
      "lineItemsStartExpanded": "none",
      "markupPercentage": "example-string",
      "order_key": 100,
      "salesTaxPercentage": "example-string",
      "scopeId": "example-string",
      "screenshotUrl": "example-string",
      "selectionType": "single",
      "showCents": true,
      "tags": [
        "example-string"
      ]
    }
  ],
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "templateId": "example-string"
}

Responses

201Proposal created successfully

dataobject

idstring

Unique identifier for the created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}

GetProposal

Retrieve detailed information about a specific proposal including all items and groups

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal retrieved successfully

archivedboolean

Whether the proposal is archived

archived_atnullable string

When the proposal was archived (ISO 8601 timestamp), or null if not archived

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

created_atstring

When the proposal was created (ISO 8601 timestamp)

created_bynullable ProposalUser

User who created the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

Visual design settings

idstring

Unique identifier for the proposal

integrationsnullable object

External integration data (CRM, payment, etc.)

is_libraryboolean

Whether this proposal is a library item

is_starredboolean

Whether the current user has starred this proposal

is_templateboolean

Whether this proposal is a reusable template

namestring

Proposal name/title

org_idstring

Organization that owns this proposal

pagesarray of object

Ordered list of proposal pages

Display and behavior settings for the proposal (API format, snake_case)

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailProposalStatusDetail

Status lifecycle and resolution details

timestampsobject

Key lifecycle timestamps

updated_atstring

When the proposal was last updated (ISO 8601 timestamp)

updated_bynullable ProposalUser

User who last updated the proposal

Example

{
  "id": "example-string",
  "name": "example-string",
  "org_id": "example-string",
  "pages": [
    {
      "content": "example-string",
      "name": "example-string",
      "order_key": 100,
      "children": [
        {
          "displayCost": "show_all",
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "kind": "group",
          "lineItems": [],
          "name": "example-string",
          "selectionType": "single",
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "hideQuantities": true,
          "in_library": true,
          "is_archived": true,
          "linkedScopeId": "example-string",
          "order_key": 100,
          "quantity": {},
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "updated_at": "example-string"
        }
      ],
      "created_at": "example-string",
      "designSettings": {
        "backgroundAttachment": "example-string",
        "backgroundColor": "example-string",
        "backgroundImage": "example-string",
        "backgroundOpacity": 100,
        "backgroundPosition": "example-string",
        "backgroundRepeat": "example-string",
        "backgroundSize": "example-string",
        "fontColor": "example-string"
      },
      "discounts": [
        {
          "amount": "example-string",
          "frequency": "example-string",
          "id": "example-string",
          "type": "fixed"
        }
      ],
      "displayHeading": true,
      "excludeFromPdf": true,
      "hideSection": true,
      "hideTotalsBottom": true,
      "hideTotalsTop": true,
      "id": "example-string",
      "isScopeOfWork": true,
      "isSignaturesPage": true,
      "kind": "example-string",
      "labels": {
        "tax": "example-string"
      },
      "lineItemsStartExpanded": "none",
      "markupPercentage": "example-string",
      "salesTaxPercentage": "example-string",
      "scopeId": "example-string",
      "screenshotUrl": "example-string",
      "selectionType": "single",
      "showCents": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "status": "DRAFT",
  "archived": true,
  "archived_at": "example-string",
  "cached_totals": {
    "annually": {
      "max": 100,
      "min": 100
    },
    "currency": "example-string",
    "monthly": {
      "max": 100,
      "min": 100
    },
    "once": {
      "max": 100,
      "min": 100
    },
    "quarterly": {
      "max": 100,
      "min": 100
    },
    "updated_at": "example-string"
  },
  "created_at": "example-string",
  "created_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      },
      "transactions": [
        {}
      ]
    }
  },
  "is_library": true,
  "is_starred": true,
  "is_template": true,
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status_detail": {
    "acceptance": {
      "accepted_at": "example-string",
      "full_name": "example-string",
      "ip_address": "example-string",
      "user_agent": "example-string"
    },
    "cancellation_note": "example-string",
    "closed_proposal_note": "example-string",
    "marked_as_won_method": "manual",
    "signature_events": [
      {
        "timestamp": "example-string",
        "type": "example-string"
      }
    ],
    "signatures": [],
    "signed_pdf_url": "example-string"
  },
  "timestamps": {
    "firstViewed": "example-string",
    "lastViewed": "example-string",
    "lost": "example-string",
    "sent": "example-string",
    "won": "example-string"
  },
  "updated_at": "example-string",
  "updated_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

errorobject

Example

{
  "error": {
    "code": "example-string",
    "message": "example-string"
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/proposals/{id}

UpdateProposal

Update proposal details such as name, description, or client information

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

integrationsnullable ProposalIntegrationsInput

External integrations (write model — payment has settings only, no transactions)

namestring

Proposal name/title

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

Display and behavior settings for the proposal (API format, snake_case)

Visual design settings for the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

status_detailProposalStatusDetail

Status lifecycle and resolution details

is_templateboolean

Whether this proposal is a reusable template

Example

{
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      }
    }
  },
  "is_template": true,
  "name": "example-string",
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status": "DRAFT",
  "status_detail": {
    "acceptance": {
      "accepted_at": "example-string",
      "full_name": "example-string",
      "ip_address": "example-string",
      "user_agent": "example-string"
    },
    "cancellation_note": "example-string",
    "closed_proposal_note": "example-string",
    "marked_as_won_method": "manual",
    "signature_events": [
      {
        "timestamp": "example-string",
        "type": "example-string"
      }
    ],
    "signatures": [],
    "signed_pdf_url": "example-string"
  }
}

Responses

200Proposal updated successfully

ProposalListItem

archivedboolean

Whether the proposal is archived

archived_atnullable string

ISO 8601 timestamp when the proposal was archived, or null if not archived

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

created_atstring

ISO 8601 timestamp when the proposal was created

created_bynullable ProposalUser

User who created the proposal

idstring

Unique identifier for the proposal

is_starredboolean

Whether the current user has starred this proposal

is_templateboolean

Whether this proposal is a reusable template

namestring

Display name of the proposal

Display and behavior settings for the proposal (API format, snake_case)

Used by: PriceConfig.anyOf[0].discount.anyOf[0]·PriceConfig.anyOf[4].discount.anyOf[0]·PriceConfig.anyOf[3].discount.anyOf[0]·PriceConfig.anyOf[1].discount.anyOf[0]·PriceConfig.anyOf[2].discount.anyOf[0]

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailobject

Status lifecycle details (subset relevant to list views)

updated_atstring

ISO 8601 timestamp when the proposal was last updated

updated_bynullable ProposalUser

User who last updated the proposal

Example

{
  "created_at": "example-string",
  "created_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "id": "example-string",
  "name": "example-string",
  "status": "DRAFT",
  "updated_at": "example-string",
  "updated_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "archived": true,
  "archived_at": "example-string",
  "cached_totals": {
    "annually": {
      "max": 100,
      "min": 100
    },
    "currency": "example-string",
    "monthly": {
      "max": 100,
      "min": 100
    },
    "once": {
      "max": 100,
      "min": 100
    },
    "quarterly": {
      "max": 100,
      "min": 100
    },
    "updated_at": "example-string"
  },
  "is_starred": true,
  "is_template": true,
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status_detail": {
    "marked_as_won_method": "manual"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/proposals/{id}

DeleteProposal

Delete a proposal and all its associated items. The proposal will no longer appear in listings.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal deleted successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/analytics

GetProposalAnalytics

Retrieve analytics events for a specific proposal. Requires authentication and org access.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Query Parameters

end_datestring

Filter events up to this date

event_typeenum

proposal_viewedproposal_sentstatus_changedproposal_signedpdf_viewedsignature_request_sent

Filter by event type

limitinteger

Default: 50. Maximum number of events to return

offsetinteger

Default: 0. Number of events to skip for pagination

start_datestring

Filter events from this date onwards

Responses

200Analytics events retrieved successfully

dataarray of object

event_timestampstring

event_typestring

idstring

metadataobject

userobject

Example

{
  "data": [
    {
      "event_timestamp": "2024-01-20T15:30:00Z",
      "event_type": "example-string",
      "id": "example-string",
      "metadata": {},
      "user": {
        "email": "example-string",
        "full_name": "example-string",
        "public_id": "example-string"
      }
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/archive

ArchiveProposal

Archive a proposal by setting its archived_at timestamp. Archived proposals are excluded from default listings and become read-only.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal archived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to archive this proposal

errorstring

Example

{
  "error": "example-string"
}

404Proposal not found

errorstring

Example

{
  "error": "example-string"
}

409Proposal is already archived

errorstring

Example

{
  "error": "example-string"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/bulk-archive

BulkArchiveItems

Archive multiple items (line items, groups) from a proposal

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

itemIdsarray of stringrequired

Array of item IDs to archive

Example

{
  "itemIds": [
    "example-string"
  ]
}

Responses

200Items archived successfully

archivedCountinteger

Number of items successfully archived

errorsarray of string

Array of error messages for failed items (only present if some items failed)

messagestring

Success message

Example

{
  "errors": [
    "example-string"
  ],
  "message": "example-string"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/duplicate

DuplicateProposal

Create a complete copy of an existing proposal with all its groups, items, and pages

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the duplicated proposal. Default: "Copy of {original name}"

Example

{
  "name": "example-string"
}

Responses

201Proposal duplicated successfully

dataobject

idstring

ID of the newly created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/pdf

GenerateProposalPDF

Generate a PDF document for the specified proposal. Returns the PDF as a binary download.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

No properties

Example

{}

Responses

200PDF generated successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/star

StarProposal

Star a proposal for the current user. Starred proposals appear first in listings. This operation is idempotent - starring an already-starred proposal has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal starred successfully

is_starredboolean

Example

{
  "is_starred": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unarchive

UnarchiveProposal

Unarchive a proposal by clearing its archived_at timestamp. The proposal will return to active status and become editable again.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal unarchived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to unarchive this proposal

errorstring

Example

{
  "error": "example-string"
}

404Proposal not found

errorstring

Example

{
  "error": "example-string"
}

409Proposal is not archived

errorstring

Example

{
  "error": "example-string"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unstar

UnstarProposal

Remove the star from a proposal for the current user. This operation is idempotent - unstarring a proposal that is not starred has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal unstarred successfully

is_starredboolean

Example

{
  "is_starred": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

Schemas

Price Configuration

Frequency

Used by: PriceConfig.anyOf[0].frequency·PriceConfig.anyOf[4].frequency·PriceConfig.anyOf[1].frequency·PriceConfig.anyOf[2].frequency

Billing frequency for recurring items

Enum values:

onceOne-time only

monthlyOnce a month

quarterlyOnce every 3 months

annuallyOnce a year

weeklyOnce a week

biweeklyOnce every two weeks

semi-monthlyTwice a month

semi-annuallyTwice a year

Example

"once"

LineItemDiscountConfig

Configuration for discounts applied to line items

addedboolean

Whether the discount has been added

isSelectedboolean

Whether the discount is currently selected/applied

scopeenum

Scope of the discount: 'unit' (per unit), 'line' (entire line), 'group' (entire group), or 'scope' (entire pricing table)

unitlinegroupscope

typeenum

Discount type: 'percentage' or 'fixed' amount

percentagefixed

amountnumber

Discount amount - percentage as decimal (e.g., 0.10 for 10%) or fixed amount in cents

Example

{
  "added": true,
  "amount": 100,
  "isSelected": true,
  "scope": "unit",
  "type": "percentage"
}

PriceConfig

Used by: PageChild.anyOf[0].lineItems.[].price·PageChild.anyOf[0].lineItems.[].children.[].price

Price configuration - discriminated union of pricing models The 'model' field determines which configuration type is used

Example

{
  "frequency": "once",
  "model": "fixed",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "isRange": true,
  "maxValue": 100,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string"
  },
  "value": 100
}

QuantityConfig3 required

Used by: PriceConfig.anyOf[0].quantity.anyOf[0]·PriceConfig.anyOf[4].quantity.anyOf[0]·PriceConfig.anyOf[3].quantity.anyOf[0]·PageChild.anyOf[0].quantity·PriceConfig.anyOf[1].quantity.anyOf[0]·PriceConfig.anyOf[2].quantity.anyOf[0]

Configuration for item quantity settings

minnumberrequired

Minimum quantity allowed

maxnumberrequired

Maximum quantity allowed

editableByRecipientbooleanrequired

Whether the recipient can edit the quantity

currentnumber

Current quantity value

unitLabelstring

Custom label for the unit (e.g., "hours", "items")

Example

{
  "editableByRecipient": true,
  "max": 100,
  "min": 100,
  "current": 100,
  "unitLabel": "example-string"
}

Item Types

ProposalListItem7 required

Used by: ListProposals (response 200)·UpdateProposal (response 200)

Summary of a proposal for use in list views

idstringrequired

Unique identifier for the proposal

statusProposalDisplayStatusrequired

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

namestringrequired

Display name of the proposal

created_bynullable ProposalUserrequired

User who created the proposal

updated_bynullable ProposalUserrequired

User who last updated the proposal

created_atstringrequired

ISO 8601 timestamp when the proposal was created

updated_atstringrequired

ISO 8601 timestamp when the proposal was last updated

archivedboolean

Whether the proposal is archived

archived_atnullable string

ISO 8601 timestamp when the proposal was archived, or null if not archived

Used by: ProposalIntegrationsInput.payment.anyOf[0].settings·GetProposal.integrations.anyOf[0].payment.anyOf[0].settings

Display and behavior settings for the proposal (API format, snake_case)

is_templateboolean

Whether this proposal is a reusable template

is_starredboolean

Whether the current user has starred this proposal

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

status_detailobject

Status lifecycle details (subset relevant to list views)

Example

{
  "created_at": "example-string",
  "created_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "id": "example-string",
  "name": "example-string",
  "status": "DRAFT",
  "updated_at": "example-string",
  "updated_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "archived": true,
  "archived_at": "example-string",
  "cached_totals": {
    "annually": {
      "max": 100,
      "min": 100
    },
    "currency": "example-string",
    "monthly": {
      "max": 100,
      "min": 100
    },
    "once": {
      "max": 100,
      "min": 100
    },
    "quarterly": {
      "max": 100,
      "min": 100
    },
    "updated_at": "example-string"
  },
  "is_starred": true,
  "is_template": true,
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status_detail": {
    "marked_as_won_method": "manual"
  }
}

Page Types

PageChild

Used by: GetProposal.pages.[].children.[]·CreateProposal.pages.[].children.[]

Discriminated union for page children (groups and side-by-sides). Both share order_key from the same namespace for interleaved ordering.

Example

{
  "displayCost": "show_all",
  "id": "example-string",
  "isOptional": true,
  "isSelected": true,
  "kind": "group",
  "lineItems": [
    {
      "children": [
        {
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "markupExempt": true,
          "name": "example-string",
          "taxExempt": true,
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "integrations": {
            "quickbooks": {
              "productId": "example-string"
            }
          },
          "is_archived": true,
          "kind": "mod",
          "label": "example-string",
          "selectionType": "single",
          "updated_at": "example-string"
        }
      ],
      "description": "example-string",
      "id": "example-string",
      "isOptional": true,
      "isSelected": true,
      "markupExempt": true,
      "name": "example-string",
      "price": {
        "frequency": "once",
        "model": "fixed",
        "isRange": true,
        "maxValue": 100,
        "value": 100
      },
      "taxExempt": true,
      "archived_at": "example-string",
      "childCount": 100,
      "created_at": "example-string",
      "hidden": true,
      "hideModifications": true,
      "in_library": true,
      "integrations": {
        "quickbooks": {
          "productId": "example-string"
        }
      },
      "internalNotes": "example-string",
      "is_archived": true,
      "label": "example-string",
      "modificationsLabel": "example-string",
      "order_key": 100,
      "parent_id": "example-string",
      "selectionType": "single",
      "startExpanded": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "name": "example-string",
  "selectionType": "single",
  "archived_at": "example-string",
  "created_at": "example-string",
  "description": "example-string",
  "hideQuantities": true,
  "in_library": true,
  "is_archived": true,
  "linkedScopeId": "example-string",
  "order_key": 100,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string"
  },
  "startExpanded": true,
  "tags": [
    "example-string"
  ],
  "updated_at": "example-string"
}

PageDesignSettings

Used by: GetProposal.pages.[].designSettings·CreateProposal.pages.[].designSettings

Visual design settings for a specific page

backgroundColorstring

Background color (CSS color value)

fontColorstring

Font/text color (CSS color value)

backgroundImagestring

URL of the background image

backgroundPositionstring

CSS background-position value

backgroundSizestring

CSS background-size value

backgroundRepeatstring

CSS background-repeat value

backgroundAttachmentstring

CSS background-attachment value

backgroundOpacitynumber

Opacity of the background image (0-1)

Example

{
  "backgroundAttachment": "example-string",
  "backgroundColor": "example-string",
  "backgroundImage": "example-string",
  "backgroundOpacity": 100,
  "backgroundPosition": "example-string",
  "backgroundRepeat": "example-string",
  "backgroundSize": "example-string",
  "fontColor": "example-string"
}

Other

ApiProposalCRMData2 required

Used by: GetProposal.integrations.anyOf[0].crm.anyOf[0]·ProposalIntegrationsInput.crm.anyOf[0]

CRM integration data in API (snake_case) format. ProposalCRMData is the DB/internal format (camelCase); this is the API-facing format.

providerenumrequired

pipedrivehubspotzohogohighlevel

client_idstringrequired

ID of the client/contact in the CRM system

deal_idstring

ID of the associated deal/opportunity in the CRM

deal_urlstring

URL to view the deal in the CRM system

deal_metadataobject

Additional metadata from the CRM integration

Example

{
  "client_id": "example-string",
  "deal_id": "example-string",
  "deal_metadata": {
    "last_synced_at": "example-string",
    "last_synced_price": 100,
    "title": "example-string"
  },
  "deal_url": "example-string"
}

ApiProposalSettings

Used by: CreateProposal.settings·GetProposal.settings·ProposalListItem.settings·UpdateProposal.settings

API-facing proposal settings (snake_case keys)

signingobject

recipientobject

notificationsobject

avoid_line_item_page_breaksboolean

hide_pdf_downloadboolean

disable_proposal_accessboolean

include_modifications_in_line_item_priceboolean

currencystring

expiring_onnullable string

email_draftobject

Example

{
  "avoid_line_item_page_breaks": true,
  "currency": "example-string",
  "disable_proposal_access": true,
  "email_draft": {
    "last_saved": "example-string",
    "message": "example-string",
    "recipients": "example-string",
    "subject": "example-string"
  },
  "expiring_on": "example-string",
  "hide_pdf_download": true,
  "include_modifications_in_line_item_price": true
}

PaymentSettings5 required

Payment configuration stored in proposals.attrs.settings.payment (This mirrors IntegrationSettings.payment from settings.ts)

enabledbooleanrequired

Whether payment collection is enabled for this proposal

typeenumrequired

Payment type (e.g., deposit, full)

percentagefixed

deposit_percentagenumberrequired

Deposit percentage required (0-100)

deposit_amountnullable numberrequired

Fixed deposit amount required

frequencystringrequired

Payment frequency schedule

Example

{
  "deposit_amount": 100,
  "deposit_percentage": 100,
  "enabled": true,
  "frequency": "example-string",
  "type": "percentage"
}

ProposalCachedTotalRange2 required

Used by: ProposalCachedTotals.annually·ProposalCachedTotals.monthly·ProposalCachedTotals.once·ProposalCachedTotals.quarterly

A price range with minimum and maximum values

minnumberrequired

Minimum total amount

maxnumberrequired

Maximum total amount

Example

{
  "max": 100,
  "min": 100
}

ProposalCachedTotals

Used by: GetProposal.cached_totals.anyOf[0]·ProposalListItem.cached_totals.anyOf[0]

Cached pricing totals for the proposal

currencystring

Currency code for the cached totals (e.g. "USD")

updated_atstring

ISO 8601 timestamp when the cached totals were last recalculated

onceProposalCachedTotalRange

One-time pricing total range

monthlyProposalCachedTotalRange

Monthly recurring pricing total range

quarterlyProposalCachedTotalRange

Quarterly recurring pricing total range

annuallyProposalCachedTotalRange

Annually recurring pricing total range

Example

{
  "currency": "example-string",
  "updated_at": "example-string"
}

ProposalCustomVariable5 required

Used by: CreateProposal.custom_variables.[]·GetProposal.custom_variables.[]·UpdateProposal.custom_variables.[]

A custom variable that can be used in proposal content

idstringrequired

Unique identifier for this custom variable

typeenumrequired

Input type of the variable

single-linemulti-linenumberdatedropdown

labelstringrequired

Display label for the variable

ordernumberrequired

Sort order position of the variable

valuestringrequired

Current value of the variable

who_providesenum

Whether the variable is filled by the sender or the client

we-docustomer-does

sourcestring

Origin source of the variable (e.g. CRM integration)

requiredboolean

Whether the variable must be filled before sending

created_atstring

ISO 8601 timestamp when the variable was created

optionsarray of string

Available options for dropdown-type variables

Example

{
  "id": "example-string",
  "label": "example-string",
  "order": 100,
  "type": "single-line",
  "value": "example-string",
  "created_at": "example-string",
  "options": [
    "example-string"
  ],
  "required": true,
  "source": "example-string",
  "who_provides": "we-do"
}

ProposalDesign

Used by: CreateProposal.design·GetProposal.design·UpdateProposal.design

Visual design settings for the proposal

colorsobject

Color settings for proposal UI elements

backgroundsobject

Background image and color settings

stylingobject

Border radius, shadow, and other styling values

fontsobject

Font family and weight settings for proposal elements

logoobject

Company logo displayed on the proposal

Example

{
  "colors": {
    "group_heading": {
      "background": "example-string",
      "checkbox": "example-string",
      "checkmark": "example-string",
      "quantity": "example-string",
      "quantity_font": "example-string",
      "text": "example-string"
    },
    "logo": {
      "background": "example-string",
      "divider_line": "example-string",
      "url": "example-string"
    },
    "primary_button_background": "example-string",
    "primary_button_border_color": "example-string",
    "primary_button_color": "example-string",
    "proposal_header": {
      "background": "example-string",
      "text": "example-string"
    },
    "proposal_navigation": {
      "background": "example-string",
      "highlight_border": "example-string",
      "highlight_color": "example-string",
      "link": "example-string",
      "selected_link": "example-string"
    },
    "secondary_button_background": "example-string",
    "secondary_button_border_color": "example-string",
    "secondary_button_color": "example-string"
  },
  "fonts": {
    "button": {
      "bold": true,
      "family": "example-string"
    },
    "content": {
      "bold": true,
      "family": "example-string"
    },
    "default": {
      "bold": true,
      "family": "example-string",
      "size": "example-string"
    },
    "group_heading": {
      "bold": true,
      "family": "example-string"
    },
    "heading": {
      "bold": true,
      "family": "example-string"
    },
    "line_item": {
      "bold": true,
      "family": "example-string"
    },
    "navigation": {
      "bold": true,
      "family": "example-string"
    },
    "pricing": {
      "bold": true,
      "family": "example-string"
    }
  },
  "logo": {
    "height": 100,
    "url": "example-string",
    "width": 100
  },
  "styling": {
    "button_border_width": 100,
    "button_radius": 100,
    "button_shadow": 100,
    "group_radius": 100,
    "group_shadow": 100,
    "page_radius": 100,
    "quantity_radius": 100
  }
}

ProposalDesignBackground

Used by: ProposalDesign.backgrounds.main·ProposalDesign.backgrounds.page

Background image settings for a proposal section

imagestring

URL of the background image

positionstring

CSS background-position value

sizestring

CSS background-size value

repeatstring

CSS background-repeat value

attachmentstring

CSS background-attachment value (e.g. "fixed", "scroll")

opacitynumber

Opacity of the background image (0 to 1)

colorsobject

Color overrides applied with the background

Example

{
  "attachment": "example-string",
  "image": "example-string",
  "opacity": 100,
  "position": "example-string",
  "repeat": "example-string",
  "size": "example-string"
}

ProposalDisplayStatus

Used by: GetProposal.status·ProposalListItem.status·UpdateProposal.status

Proposal status

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

Example

"DRAFT"

ProposalIntegrationsInput

Used by: CreateProposal.integrations.anyOf[0]·UpdateProposal.integrations.anyOf[0]

Write-side integrations input (transactions are server-managed, not client-writable)

crmnullable ApiProposalCRMData

CRM integration data to link/unlink

paymentnullable object

Payment configuration (settings only; transactions are managed server-side)

Example

{
  "payment": {}
}

ProposalStatusDetail

Used by: GetProposal.status_detail·UpdateProposal.status_detail

Status lifecycle and resolution details for a proposal

acceptancenullable object

Details of the proposal acceptance, if accepted via accept button

cancellation_notestring

Note explaining why the proposal was cancelled

closed_proposal_notestring

Note displayed when the proposal is closed (won/lost)

marked_as_won_methodnullable enum

Method used to mark the proposal as won

manualdigital_signatureacceptancenull

signature_eventsnullable array of object

Chronological log of signature-related events

signaturesnullable array of Record%3Cstring%2Cunknown%3E

Collected digital signatures on the proposal

signed_pdf_urlnullable string

URL of the signed PDF document, if available

Example

{
  "cancellation_note": "example-string",
  "closed_proposal_note": "example-string",
  "marked_as_won_method": "manual",
  "signature_events": [
    {
      "timestamp": "example-string",
      "type": "example-string"
    }
  ],
  "signatures": [],
  "signed_pdf_url": "example-string"
}

ProposalUser3 required

Used by: GetProposal.created_by.anyOf[0]·GetProposal.updated_by.anyOf[0]·ProposalListItem.created_by.anyOf[0]·ProposalListItem.updated_by.anyOf[0]

User profile embedded in proposal responses (used for both created_by and updated_by)

idstringrequired

Public user ID

namestringrequired

Full name

emailstringrequired

Email address

avatar_urlnullable string

Avatar image URL

Example

{
  "email": "example-string",
  "id": "example-string",
  "name": "example-string",
  "avatar_url": "example-string"
}

API Docs

Quick Links

Authentication Pagination OpenAPI Spec

Endpoints

Schemas

Base URLhttps://web.smartpricingtable.com/api

View OpenAPI Spec

Beta

This API is in beta. Endpoints and response shapes may change as we iterate. For questions or feedback, email support@smartpricingtable.com.

Authentication

API Key Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can create and manage API keys from your profile settings.

Pagination

List endpoints return paginated results. Include page and limit query parameters to control which page of results you receive.

Request Parameters

Parameter	Type	Default	Description
page	integer	1	Page number (starts at 1)
limit	integer	20	Items per page (1–100)

Response Format

Every list response includes a pagination object alongside the data array:

{
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

Proposals(13)

GET/proposals

ListProposals

Retrieve a paginated list of proposals for the authenticated user's organization

Query Parameters

archivedenum

falsedefaulttrueany

Filter by archive status (false=non-archived, true=archived only, any=both)

created_bystring

Filter by creator's public_id

limitinteger

Default: 20. Number of items per page

orderenum

descdefaultasc

Sort order

pageinteger

Default: 1. Page number for pagination

searchstring

Search term to filter proposals by name or client

sortenum

created_atdefaultupdated_atnamestatus

Field to sort by

statusenum

draftsentwonlostcancelled

Filter by proposal status

Responses

200Successful response with proposals list

dataarray of ProposalListItem

archivedboolean

Whether the proposal is archived

archived_atnullable string

ISO 8601 timestamp when the proposal was archived, or null if not archived

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

created_atstring

ISO 8601 timestamp when the proposal was created

created_bynullable ProposalUser

User who created the proposal

idstring

Unique identifier for the proposal

is_starredboolean

Whether the current user has starred this proposal

is_templateboolean

Whether this proposal is a reusable template

namestring

Display name of the proposal

Display and behavior settings for the proposal (API format, snake_case)

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailobject

Status lifecycle details (subset relevant to list views)

updated_atstring

ISO 8601 timestamp when the proposal was last updated

updated_bynullable ProposalUser

User who last updated the proposal

paginationobject

Example

{
  "data": [
    {
      "created_at": "example-string",
      "created_by": {
        "email": "example-string",
        "id": "example-string",
        "name": "example-string",
        "avatar_url": "example-string"
      },
      "id": "example-string",
      "name": "example-string",
      "status": "DRAFT",
      "updated_at": "example-string",
      "updated_by": {
        "email": "example-string",
        "id": "example-string",
        "name": "example-string",
        "avatar_url": "example-string"
      },
      "archived": true,
      "archived_at": "example-string",
      "cached_totals": {
        "annually": {
          "max": 100,
          "min": 100
        },
        "currency": "example-string",
        "monthly": {
          "max": 100,
          "min": 100
        },
        "once": {
          "max": 100,
          "min": 100
        },
        "quarterly": {
          "max": 100,
          "min": 100
        },
        "updated_at": "example-string"
      },
      "is_starred": true,
      "is_template": true,
      "settings": {
        "avoid_line_item_page_breaks": true,
        "currency": "example-string",
        "disable_proposal_access": true,
        "email_draft": {
          "last_saved": "example-string",
          "message": "example-string",
          "recipients": "example-string",
          "subject": "example-string"
        },
        "expiring_on": "example-string",
        "hide_pdf_download": true,
        "include_modifications_in_line_item_price": true,
        "notifications": {
          "override_account_defaults": true,
          "rules": [
            {}
          ]
        },
        "recipient": {
          "address": "example-string",
          "contact": {
            "email": "example-string",
            "name": "example-string",
            "phone": "example-string"
          },
          "name": "example-string",
          "website": "example-string"
        },
        "signing": {
          "additional_signers": [
            {}
          ],
          "company_signer": "example-string",
          "custom_company_signer_email": "example-string",
          "custom_company_signer_name": "example-string",
          "is_contact_signer": true,
          "is_multiple_signers": true,
          "override_signature_page_defaults": true,
          "recipient_signer": {
            "email": "example-string",
            "full_name": "example-string"
          },
          "signature_page_agreement_text": "example-string",
          "signature_page_client_label": "example-string",
          "signature_page_company_label": "example-string",
          "use_accept": true
        }
      },
      "status_detail": {
        "marked_as_won_method": "manual"
      }
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals

CreateProposal

Create a new proposal for the user's organization

Request Body

namestringrequired

Proposal name (required)

templateIdstring

Template ID to duplicate from

pagesarray of object

Pages array (for duplication, empty array prevents default page creation)

integrationsnullable ProposalIntegrationsInput

External integrations (write model — payment has settings only, no transactions)

Display and behavior settings for the proposal (API format, snake_case)

Visual design settings for the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

is_templateboolean

Whether this proposal is a reusable template

Example

{
  "name": "example-string",
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      }
    }
  },
  "is_template": true,
  "pages": [
    {
      "name": "example-string",
      "children": [
        {
          "displayCost": "show_all",
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "kind": "group",
          "lineItems": [],
          "name": "example-string",
          "selectionType": "single",
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "hideQuantities": true,
          "in_library": true,
          "is_archived": true,
          "linkedScopeId": "example-string",
          "order_key": 100,
          "quantity": {},
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "updated_at": "example-string"
        }
      ],
      "content": "example-string",
      "designSettings": {
        "backgroundAttachment": "example-string",
        "backgroundColor": "example-string",
        "backgroundImage": "example-string",
        "backgroundOpacity": 100,
        "backgroundPosition": "example-string",
        "backgroundRepeat": "example-string",
        "backgroundSize": "example-string",
        "fontColor": "example-string"
      },
      "discounts": [
        {
          "amount": "example-string",
          "frequency": "example-string",
          "id": "example-string",
          "type": "fixed"
        }
      ],
      "displayHeading": true,
      "excludeFromPdf": true,
      "hideSection": true,
      "hideTotalsBottom": true,
      "hideTotalsTop": true,
      "isScopeOfWork": true,
      "isSignaturesPage": true,
      "kind": "example-string",
      "labels": {
        "tax": "example-string"
      },
      "lineItemsStartExpanded": "none",
      "markupPercentage": "example-string",
      "order_key": 100,
      "salesTaxPercentage": "example-string",
      "scopeId": "example-string",
      "screenshotUrl": "example-string",
      "selectionType": "single",
      "showCents": true,
      "tags": [
        "example-string"
      ]
    }
  ],
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "templateId": "example-string"
}

Responses

201Proposal created successfully

dataobject

idstring

Unique identifier for the created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}

GetProposal

Retrieve detailed information about a specific proposal including all items and groups

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal retrieved successfully

archivedboolean

Whether the proposal is archived

archived_atnullable string

When the proposal was archived (ISO 8601 timestamp), or null if not archived

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

created_atstring

When the proposal was created (ISO 8601 timestamp)

created_bynullable ProposalUser

User who created the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

Visual design settings

idstring

Unique identifier for the proposal

integrationsnullable object

External integration data (CRM, payment, etc.)

is_libraryboolean

Whether this proposal is a library item

is_starredboolean

Whether the current user has starred this proposal

is_templateboolean

Whether this proposal is a reusable template

namestring

Proposal name/title

org_idstring

Organization that owns this proposal

pagesarray of object

Ordered list of proposal pages

Display and behavior settings for the proposal (API format, snake_case)

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailProposalStatusDetail

Status lifecycle and resolution details

timestampsobject

Key lifecycle timestamps

updated_atstring

When the proposal was last updated (ISO 8601 timestamp)

updated_bynullable ProposalUser

User who last updated the proposal

Example

{
  "id": "example-string",
  "name": "example-string",
  "org_id": "example-string",
  "pages": [
    {
      "content": "example-string",
      "name": "example-string",
      "order_key": 100,
      "children": [
        {
          "displayCost": "show_all",
          "id": "example-string",
          "isOptional": true,
          "isSelected": true,
          "kind": "group",
          "lineItems": [],
          "name": "example-string",
          "selectionType": "single",
          "archived_at": "example-string",
          "created_at": "example-string",
          "description": "example-string",
          "hideQuantities": true,
          "in_library": true,
          "is_archived": true,
          "linkedScopeId": "example-string",
          "order_key": 100,
          "quantity": {},
          "startExpanded": true,
          "tags": [
            "example-string"
          ],
          "updated_at": "example-string"
        }
      ],
      "created_at": "example-string",
      "designSettings": {
        "backgroundAttachment": "example-string",
        "backgroundColor": "example-string",
        "backgroundImage": "example-string",
        "backgroundOpacity": 100,
        "backgroundPosition": "example-string",
        "backgroundRepeat": "example-string",
        "backgroundSize": "example-string",
        "fontColor": "example-string"
      },
      "discounts": [
        {
          "amount": "example-string",
          "frequency": "example-string",
          "id": "example-string",
          "type": "fixed"
        }
      ],
      "displayHeading": true,
      "excludeFromPdf": true,
      "hideSection": true,
      "hideTotalsBottom": true,
      "hideTotalsTop": true,
      "id": "example-string",
      "isScopeOfWork": true,
      "isSignaturesPage": true,
      "kind": "example-string",
      "labels": {
        "tax": "example-string"
      },
      "lineItemsStartExpanded": "none",
      "markupPercentage": "example-string",
      "salesTaxPercentage": "example-string",
      "scopeId": "example-string",
      "screenshotUrl": "example-string",
      "selectionType": "single",
      "showCents": true,
      "tags": [
        "example-string"
      ],
      "updated_at": "example-string"
    }
  ],
  "status": "DRAFT",
  "archived": true,
  "archived_at": "example-string",
  "cached_totals": {
    "annually": {
      "max": 100,
      "min": 100
    },
    "currency": "example-string",
    "monthly": {
      "max": 100,
      "min": 100
    },
    "once": {
      "max": 100,
      "min": 100
    },
    "quarterly": {
      "max": 100,
      "min": 100
    },
    "updated_at": "example-string"
  },
  "created_at": "example-string",
  "created_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      },
      "transactions": [
        {}
      ]
    }
  },
  "is_library": true,
  "is_starred": true,
  "is_template": true,
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status_detail": {
    "acceptance": {
      "accepted_at": "example-string",
      "full_name": "example-string",
      "ip_address": "example-string",
      "user_agent": "example-string"
    },
    "cancellation_note": "example-string",
    "closed_proposal_note": "example-string",
    "marked_as_won_method": "manual",
    "signature_events": [
      {
        "timestamp": "example-string",
        "type": "example-string"
      }
    ],
    "signatures": [],
    "signed_pdf_url": "example-string"
  },
  "timestamps": {
    "firstViewed": "example-string",
    "lastViewed": "example-string",
    "lost": "example-string",
    "sent": "example-string",
    "won": "example-string"
  },
  "updated_at": "example-string",
  "updated_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

errorobject

Example

{
  "error": {
    "code": "example-string",
    "message": "example-string"
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

PATCH/proposals/{id}

UpdateProposal

Update proposal details such as name, description, or client information

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

integrationsnullable ProposalIntegrationsInput

External integrations (write model — payment has settings only, no transactions)

namestring

Proposal name/title

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

Display and behavior settings for the proposal (API format, snake_case)

Visual design settings for the proposal

custom_variablesarray of ProposalCustomVariable

Custom variables used in the proposal content

status_detailProposalStatusDetail

Status lifecycle and resolution details

is_templateboolean

Whether this proposal is a reusable template

Example

{
  "custom_variables": [
    {
      "id": "example-string",
      "label": "example-string",
      "order": 100,
      "type": "single-line",
      "value": "example-string",
      "created_at": "example-string",
      "options": [
        "example-string"
      ],
      "required": true,
      "source": "example-string",
      "who_provides": "we-do"
    }
  ],
  "design": {
    "backgrounds": {
      "main": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      },
      "page": {
        "attachment": "example-string",
        "colors": {
          "background": "example-string",
          "font": "example-string"
        },
        "image": "example-string",
        "opacity": 100,
        "position": "example-string",
        "repeat": "example-string",
        "size": "example-string"
      }
    },
    "colors": {
      "group_heading": {
        "background": "example-string",
        "checkbox": "example-string",
        "checkmark": "example-string",
        "quantity": "example-string",
        "quantity_font": "example-string",
        "text": "example-string"
      },
      "logo": {
        "background": "example-string",
        "divider_line": "example-string",
        "url": "example-string"
      },
      "primary_button_background": "example-string",
      "primary_button_border_color": "example-string",
      "primary_button_color": "example-string",
      "proposal_header": {
        "background": "example-string",
        "text": "example-string"
      },
      "proposal_navigation": {
        "background": "example-string",
        "highlight_border": "example-string",
        "highlight_color": "example-string",
        "link": "example-string",
        "selected_link": "example-string"
      },
      "secondary_button_background": "example-string",
      "secondary_button_border_color": "example-string",
      "secondary_button_color": "example-string"
    },
    "fonts": {
      "button": {
        "bold": true,
        "family": "example-string"
      },
      "content": {
        "bold": true,
        "family": "example-string"
      },
      "default": {
        "bold": true,
        "family": "example-string",
        "size": "example-string"
      },
      "group_heading": {
        "bold": true,
        "family": "example-string"
      },
      "heading": {
        "bold": true,
        "family": "example-string"
      },
      "line_item": {
        "bold": true,
        "family": "example-string"
      },
      "navigation": {
        "bold": true,
        "family": "example-string"
      },
      "pricing": {
        "bold": true,
        "family": "example-string"
      }
    },
    "logo": {
      "height": 100,
      "url": "example-string",
      "width": 100
    },
    "styling": {
      "button_border_width": 100,
      "button_radius": 100,
      "button_shadow": 100,
      "group_radius": 100,
      "group_shadow": 100,
      "page_radius": 100,
      "quantity_radius": 100
    }
  },
  "integrations": {
    "crm": {
      "client_id": "example-string",
      "provider": "pipedrive",
      "deal_id": "example-string",
      "deal_metadata": {
        "last_synced_at": "example-string",
        "last_synced_price": 100,
        "title": "example-string"
      },
      "deal_url": "example-string"
    },
    "payment": {
      "settings": {
        "deposit_amount": 100,
        "deposit_percentage": 100,
        "enabled": true,
        "frequency": "example-string",
        "type": "percentage"
      }
    }
  },
  "is_template": true,
  "name": "example-string",
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status": "DRAFT",
  "status_detail": {
    "acceptance": {
      "accepted_at": "example-string",
      "full_name": "example-string",
      "ip_address": "example-string",
      "user_agent": "example-string"
    },
    "cancellation_note": "example-string",
    "closed_proposal_note": "example-string",
    "marked_as_won_method": "manual",
    "signature_events": [
      {
        "timestamp": "example-string",
        "type": "example-string"
      }
    ],
    "signatures": [],
    "signed_pdf_url": "example-string"
  }
}

Responses

200Proposal updated successfully

ProposalListItem

archivedboolean

Whether the proposal is archived

archived_atnullable string

ISO 8601 timestamp when the proposal was archived, or null if not archived

cached_totalsnullable ProposalCachedTotals

Cached pricing totals for quick display

created_atstring

ISO 8601 timestamp when the proposal was created

created_bynullable ProposalUser

User who created the proposal

idstring

Unique identifier for the proposal

is_starredboolean

Whether the current user has starred this proposal

is_templateboolean

Whether this proposal is a reusable template

namestring

Display name of the proposal

Display and behavior settings for the proposal (API format, snake_case)

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

status_detailobject

Status lifecycle details (subset relevant to list views)

updated_atstring

ISO 8601 timestamp when the proposal was last updated

updated_bynullable ProposalUser

User who last updated the proposal

Example

{
  "created_at": "example-string",
  "created_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "id": "example-string",
  "name": "example-string",
  "status": "DRAFT",
  "updated_at": "example-string",
  "updated_by": {
    "email": "example-string",
    "id": "example-string",
    "name": "example-string",
    "avatar_url": "example-string"
  },
  "archived": true,
  "archived_at": "example-string",
  "cached_totals": {
    "annually": {
      "max": 100,
      "min": 100
    },
    "currency": "example-string",
    "monthly": {
      "max": 100,
      "min": 100
    },
    "once": {
      "max": 100,
      "min": 100
    },
    "quarterly": {
      "max": 100,
      "min": 100
    },
    "updated_at": "example-string"
  },
  "is_starred": true,
  "is_template": true,
  "settings": {
    "avoid_line_item_page_breaks": true,
    "currency": "example-string",
    "disable_proposal_access": true,
    "email_draft": {
      "last_saved": "example-string",
      "message": "example-string",
      "recipients": "example-string",
      "subject": "example-string"
    },
    "expiring_on": "example-string",
    "hide_pdf_download": true,
    "include_modifications_in_line_item_price": true,
    "notifications": {
      "override_account_defaults": true,
      "rules": [
        {
          "emails": [
            "example-string"
          ],
          "event": "proposal_sent",
          "id": "example-string"
        }
      ]
    },
    "recipient": {
      "address": "example-string",
      "contact": {
        "email": "example-string",
        "name": "example-string",
        "phone": "example-string"
      },
      "name": "example-string",
      "website": "example-string"
    },
    "signing": {
      "additional_signers": [
        {
          "email": "example-string",
          "full_name": "example-string",
          "id": "example-string",
          "role": "example-string"
        }
      ],
      "company_signer": "example-string",
      "custom_company_signer_email": "example-string",
      "custom_company_signer_name": "example-string",
      "is_contact_signer": true,
      "is_multiple_signers": true,
      "override_signature_page_defaults": true,
      "recipient_signer": {
        "email": "example-string",
        "full_name": "example-string"
      },
      "signature_page_agreement_text": "example-string",
      "signature_page_client_label": "example-string",
      "signature_page_company_label": "example-string",
      "use_accept": true
    }
  },
  "status_detail": {
    "marked_as_won_method": "manual"
  }
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

DELETE/proposals/{id}

DeleteProposal

Delete a proposal and all its associated items. The proposal will no longer appear in listings.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal deleted successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

GET/proposals/{id}/analytics

GetProposalAnalytics

Retrieve analytics events for a specific proposal. Requires authentication and org access.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Query Parameters

end_datestring

Filter events up to this date

event_typeenum

proposal_viewedproposal_sentstatus_changedproposal_signedpdf_viewedsignature_request_sent

Filter by event type

limitinteger

Default: 50. Maximum number of events to return

offsetinteger

Default: 0. Number of events to skip for pagination

start_datestring

Filter events from this date onwards

Responses

200Analytics events retrieved successfully

dataarray of object

event_timestampstring

event_typestring

idstring

metadataobject

userobject

Example

{
  "data": [
    {
      "event_timestamp": "2024-01-20T15:30:00Z",
      "event_type": "example-string",
      "id": "example-string",
      "metadata": {},
      "user": {
        "email": "example-string",
        "full_name": "example-string",
        "public_id": "example-string"
      }
    }
  ]
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/archive

ArchiveProposal

Archive a proposal by setting its archived_at timestamp. Archived proposals are excluded from default listings and become read-only.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal archived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to archive this proposal

errorstring

Example

{
  "error": "example-string"
}

404Proposal not found

errorstring

Example

{
  "error": "example-string"
}

409Proposal is already archived

errorstring

Example

{
  "error": "example-string"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/bulk-archive

BulkArchiveItems

Archive multiple items (line items, groups) from a proposal

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

itemIdsarray of stringrequired

Array of item IDs to archive

Example

{
  "itemIds": [
    "example-string"
  ]
}

Responses

200Items archived successfully

archivedCountinteger

Number of items successfully archived

errorsarray of string

Array of error messages for failed items (only present if some items failed)

messagestring

Success message

Example

{
  "errors": [
    "example-string"
  ],
  "message": "example-string"
}

400Validation error

errorobject

Example

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "example-string",
    "details": {}
  }
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/duplicate

DuplicateProposal

Create a complete copy of an existing proposal with all its groups, items, and pages

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

namestring

Name for the duplicated proposal. Default: "Copy of {original name}"

Example

{
  "name": "example-string"
}

Responses

201Proposal duplicated successfully

dataobject

idstring

ID of the newly created proposal

Example

{
  "data": {
    "id": "example-string"
  }
}

400Validation error

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Insufficient permissions

errorobject

Example

{
  "error": {
    "code": "FORBIDDEN",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/pdf

GenerateProposalPDF

Generate a PDF document for the specified proposal. Returns the PDF as a binary download.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Request Body

No properties

Example

{}

Responses

200PDF generated successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Proposal not found

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/star

StarProposal

Star a proposal for the current user. Starred proposals appear first in listings. This operation is idempotent - starring an already-starred proposal has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal starred successfully

is_starredboolean

Example

{
  "is_starred": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unarchive

UnarchiveProposal

Unarchive a proposal by clearing its archived_at timestamp. The proposal will return to active status and become editable again.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

204Proposal unarchived successfully

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

403Not authorized to unarchive this proposal

errorstring

Example

{
  "error": "example-string"
}

404Proposal not found

errorstring

Example

{
  "error": "example-string"
}

409Proposal is not archived

errorstring

Example

{
  "error": "example-string"
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

POST/proposals/{id}/unstar

UnstarProposal

Remove the star from a proposal for the current user. This operation is idempotent - unstarring a proposal that is not starred has no effect.

Path Parameters

idstringrequired

Proposal ID

e.g., zw5FD5HGcfE3

Responses

200Proposal unstarred successfully

is_starredboolean

Example

{
  "is_starred": true
}

401Authentication required

errorobject

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "example-string",
    "details": {}
  }
}

404Not Found - Resource does not exist or access denied

errorobject

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "example-string",
    "details": {}
  }
}

500Internal server error

errorobject

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "example-string",
    "details": {}
  }
}

Schemas

Price Configuration

Frequency

Used by: PriceConfig.anyOf[0].frequency·PriceConfig.anyOf[4].frequency·PriceConfig.anyOf[1].frequency·PriceConfig.anyOf[2].frequency

Billing frequency for recurring items

Enum values:

onceOne-time only

monthlyOnce a month

quarterlyOnce every 3 months

annuallyOnce a year

weeklyOnce a week

biweeklyOnce every two weeks

semi-monthlyTwice a month

semi-annuallyTwice a year

Example

"once"

LineItemDiscountConfig

Configuration for discounts applied to line items

addedboolean

Whether the discount has been added

isSelectedboolean

Whether the discount is currently selected/applied

scopeenum

Scope of the discount: 'unit' (per unit), 'line' (entire line), 'group' (entire group), or 'scope' (entire pricing table)

unitlinegroupscope

typeenum

Discount type: 'percentage' or 'fixed' amount

percentagefixed

amountnumber

Discount amount - percentage as decimal (e.g., 0.10 for 10%) or fixed amount in cents

Example

{
  "added": true,
  "amount": 100,
  "isSelected": true,
  "scope": "unit",
  "type": "percentage"
}

PriceConfig

Used by: PageChild.anyOf[0].lineItems.[].price·PageChild.anyOf[0].lineItems.[].children.[].price

Price configuration - discriminated union of pricing models The 'model' field determines which configuration type is used

Example

{
  "frequency": "once",
  "model": "fixed",
  "discount": {
    "added": true,
    "amount": 100,
    "isSelected": true,
    "scope": "unit",
    "type": "percentage"
  },
  "isRange": true,
  "maxValue": 100,
  "quantity": {
    "editableByRecipient": true,
    "max": 100,
    "min": 100,
    "current": 100,
    "unitLabel": "example-string"
  },
  "value": 100
}

QuantityConfig3 required

Configuration for item quantity settings

minnumberrequired

Minimum quantity allowed

maxnumberrequired

Maximum quantity allowed

editableByRecipientbooleanrequired

Whether the recipient can edit the quantity

currentnumber

Current quantity value

unitLabelstring

Custom label for the unit (e.g., "hours", "items")

Example

{
  "editableByRecipient": true,
  "max": 100,
  "min": 100,
  "current": 100,
  "unitLabel": "example-string"
}

Item Types

ProposalListItem7 required

Used by: ListProposals (response 200)·UpdateProposal (response 200)

Summary of a proposal for use in list views

idstringrequired

Unique identifier for the proposal

statusProposalDisplayStatusrequired

Current workflow status of the proposal

DRAFTSENTPENDINGCANCELLEDWONLOSTEXPIRED

namestringrequired

Display name of the proposal

created_bynullable ProposalUserrequired

User who created the proposal

updated_bynullable ProposalUserrequired

User who last updated the proposal

created_atstringrequired

ISO 8601 timestamp when the proposal was created

updated_atstringrequired

ISO 8601 timestamp when the proposal was last updated

archivedboolean

Whether the proposal is archived

archived_atnullable string

ISO 8601 timestamp when the proposal was archived, or null if not archived