Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Proposals

Retrieve Proposal Template

Returns a proposal template

get/tenants/{tenant_id}/proposal_templates/{proposal_template_id}

Path parameters

tenant_idstring uuid required

The ID of the tenant that the proposal template is part of.

proposal_template_idstring uuid required

The ID of the proposal template itself.

Response

Proposal Template successfully retrieved.

idstring uuid

Unique ID identifying the proposal template.

namestring

Name of the proposal template.

created_atstring date-time

The timestamp of when the proposal template was created in UTC.

updated_atstring date-time

The timestamp of when the proposal template was updated in UTC.

last_usedstring date-time

The timestamp of when the last time the proposal template was used to generate a proposal in UTC.

enabledboolean

Whether or not the proposal template has been enabled for usage.

defaultboolean

Whether or not the proposal template is the default template used for generating proposals.

authorstring

The name of the organization which created the proposal template. This can be Aurora, the tenant, or a partner.

author_partner_idstring uuid

Unique ID identifying the partner which created the proposal template. If the template was not created by a partner, this will return null.

assigned_partner_idsstring[]

List of partner ids assigned to the proposal template.

all_partners_assignedboolean

Whether or not the proposal template is assigned to all partners.

partner_defaultsstring[]

List of partner ids who have the template set as their default

Example response

{
  "name": "My first test proposal template"
}