Get Proposal
curl --request GET \
--url https://api.proposales.com/v3/proposals/{uuid} \
--header 'Authorization: Bearer <token>'{
"data": {
"title": "<string>",
"title_md": "<string>",
"description_html": "<string>",
"description_md": "<string>",
"archived_at": 123,
"attachments": [
{}
],
"background_image": {
"id": 123,
"uuid": "<string>"
},
"background_video": {
"id": 123,
"uuid": "<string>"
},
"blocks": [
{}
],
"company_address": "<string>",
"company_email": "<string>",
"company_id": 123,
"company_logo_uuid": "<string>",
"company_powerups": {},
"company_powerups_live": {},
"company_name": "<string>",
"company_phone": "<string>",
"company_registration_number": "<string>",
"company_tax_mode_live": "<string>",
"company_timezone": "<string>",
"company_avatar_uuid": "<string>",
"contact_email": "<string>",
"contact_name": "<string>",
"contact_phone": "<string>",
"contact_title": "<string>",
"creator_id": 123,
"creator_name": "<string>",
"currency": "<string>",
"data": {},
"editor": {
"notification_user_ids": {}
},
"expires_at": 123,
"invoicing": {},
"is_agreement": true,
"is_only_proposal_in_series": true,
"is_test": true,
"pending": true,
"pending_reason": "<string>",
"recipient_company_name": "<string>",
"recipient_email": "<string>",
"recipient_id": 123,
"recipient_is_set": true,
"recipient_name": "<string>",
"recipient_phone": "<string>",
"recipient_sources": {},
"series_uuid": "<string>",
"signatures": [
{}
],
"status_changed_at": 123,
"tax_options": {},
"tracking": {},
"updated_at": 123,
"value_with_tax": 123,
"value_without_tax": 123,
"version": 123,
"payments_enabled": true,
"contact_avatar_transform": "<string>",
"user_email": "<string>",
"payment": {},
"status": "<string>",
"uuid": "<string>",
"language": "<string>",
"background_image_uuid": "<string>"
}
}Proposals
Get Proposal
Get a proposal by its UUID
GET
/
v3
/
proposals
/
{uuid}
Get Proposal
curl --request GET \
--url https://api.proposales.com/v3/proposals/{uuid} \
--header 'Authorization: Bearer <token>'{
"data": {
"title": "<string>",
"title_md": "<string>",
"description_html": "<string>",
"description_md": "<string>",
"archived_at": 123,
"attachments": [
{}
],
"background_image": {
"id": 123,
"uuid": "<string>"
},
"background_video": {
"id": 123,
"uuid": "<string>"
},
"blocks": [
{}
],
"company_address": "<string>",
"company_email": "<string>",
"company_id": 123,
"company_logo_uuid": "<string>",
"company_powerups": {},
"company_powerups_live": {},
"company_name": "<string>",
"company_phone": "<string>",
"company_registration_number": "<string>",
"company_tax_mode_live": "<string>",
"company_timezone": "<string>",
"company_avatar_uuid": "<string>",
"contact_email": "<string>",
"contact_name": "<string>",
"contact_phone": "<string>",
"contact_title": "<string>",
"creator_id": 123,
"creator_name": "<string>",
"currency": "<string>",
"data": {},
"editor": {
"notification_user_ids": {}
},
"expires_at": 123,
"invoicing": {},
"is_agreement": true,
"is_only_proposal_in_series": true,
"is_test": true,
"pending": true,
"pending_reason": "<string>",
"recipient_company_name": "<string>",
"recipient_email": "<string>",
"recipient_id": 123,
"recipient_is_set": true,
"recipient_name": "<string>",
"recipient_phone": "<string>",
"recipient_sources": {},
"series_uuid": "<string>",
"signatures": [
{}
],
"status_changed_at": 123,
"tax_options": {},
"tracking": {},
"updated_at": 123,
"value_with_tax": 123,
"value_without_tax": 123,
"version": 123,
"payments_enabled": true,
"contact_avatar_transform": "<string>",
"user_email": "<string>",
"payment": {},
"status": "<string>",
"uuid": "<string>",
"language": "<string>",
"background_image_uuid": "<string>"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.proposales.com/llms.txt
Use this file to discover all available pages before exploring further.
The UUID of the proposal
Response
Show properties
Show properties
The UNIX timestamp when the proposal was archived.
null if active.Show child attributes
Show child attributes
Show child attributes
Show child attributes
Expiration date as UNIX timestamp, null if no expiration date.
The status of the proposal.
The proposal UUID.
The language of the proposal.
The background image UUID of the template.
⌘I