Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Proposals

List Proposal Templates

Returns a list of proposal templates

The default proposal template will be the first template in the list followed by the rest in descending order based on enabled status and creation date.

get/tenants/{tenant_id}/proposal_templates

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design is part of.

Query parameters

pageinteger

Page to return, 1-indexed (default 1)

per_pageinteger

Number of items to return per page (default 50, max 250)

enabledboolean

Whether to return only proposal templates that are enabled

defaultboolean

Whether to return only the default proposal templates

namestring

Returns only the proposal templates matching the name provided

Response

Proposal Templates successfully retrieved.

Example response

{
  "proposal_templates": [
    {
      "name": "My first test proposal template"
    }
  ]
}