API Docs / Operations / Proposals / List Proposals

List Proposals

GET /api/tenants/{tenant}/proposals

Lists all Proposals for the given tenant.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

search query string

Search across proposal code, client name, and client code (minimum 3 characters)

Search across proposal code, client name, and client code (minimum 3 characters)

status query string

Filter by proposal status (Unsent, Sent, Accepted, Rejected)

Filter by proposal status (Unsent, Sent, Accepted, Rejected)

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

Client Code Date Status NumberOfServices AnnualValue

Field to sort by.

Client Code Date Status NumberOfServices AnnualValue

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

401 Unauthorized - Invalid or missing API key

Try it