Skip to main content
GET
/
proposals
/
{proposal_id}
Get Proposal
curl --request GET \
  --url https://api.example.com/proposals/{proposal_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "clientName": "<string>",
  "clientLocation": "<string>",
  "currency": "<string>",
  "hourlyRate": "<string>",
  "requirements": [
    {}
  ],
  "settings": {},
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total": "<string>",
  "outcome": "<string>",
  "outcomeAt": "2023-11-07T05:31:56Z",
  "outcomeReason": "<string>",
  "outcomeNotes": "<string>",
  "outcomeValue": "<string>",
  "authorName": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

proposal_id
string<uuid>
required

Response

Successful Response

Schema for proposal response.

id
string<uuid>
required
userId
string<uuid>
required
name
string
required
clientName
string | null
required
clientLocation
string | null
required
currency
string
required
hourlyRate
string
required
requirements
Requirements · object[]
required
settings
Settings · object
required
status
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
teamId
string<uuid> | null
total
string | null
outcome
string | null
outcomeAt
string<date-time> | null
outcomeReason
string | null
outcomeNotes
string | null
outcomeValue
string | null
authorName
string | null