💼

proposals

Business proposal or bid document submitted to potential clients. Contains proposal details, pricing, client information, submission dates, validity period, and current status.

🎯 Request Builder

https://api.mockly.codes/proposals?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/proposals

Get a collection of proposals

Alternative: /business/proposals
GET/proposals/:id

Get a single proposal by ID

Alternative: /business/proposals/:id
GET/proposals/meta

Get resource metadata and schema

Alternative: /business/proposals/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/proposals?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/proposals?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 proposals
fetch('https://api.mockly.codes/proposals?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/proposals?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/proposals?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/proposals?nocache=true')

Schema Properties

idinteger

Unique identifier for the proposal record

Gen:random_int
titlestring

Title or subject of the proposal

Gen:sentence
client_idinteger

Foreign key reference to the client or prospect the proposal is submitted to

Gen:random_int
descriptionstring

Detailed description of the proposed solution, services, or project scope

Gen:paragraph
valuenumber

Total proposed value or price for the services or project

Gen:price
currencystring

ISO currency code for the proposal value (e.g., USD, EUR, GBP)

Gen:currency
statusstring

Current status of the proposal (e.g., draft, submitted, under-review, accepted, rejected, expired)

Gen:status
submitted_datestring

Date and time when the proposal was submitted to the client

Gen:past_datedate-time
valid_untilstring

Expiration date after which the proposal terms are no longer valid

Gen:future_datedate
created_bystring

Full name of the person who created or authored the proposal

Gen:name

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request