Rise CRM icon

Rise CRM

Interact with Rise CRM API

Contract → Get All

AI-generated

Summary

Fetch contracts matching optional filters, returning up to a configured limit or all results, and support binary file upload via a designated property.

Inputs

  • returnAll — When true, ignore the limit and return all matching contracts; otherwise the limit parameter controls the maximum number returned.
  • limit — Maximum number of contracts to retrieve when Return All is disabled; must be at least 1.
  • filters — Collection of filter criteria such as client, project, status, search term, start/end dates to narrow the contract query.
  • binaryPropertyName (required) — Name of the binary property that holds the file to be uploaded when binary data is sent.

Output shape

a list of contract records (up to the configured limit unless Return All is enabled)

Pagination is handled internally; when binaryPropertyName is used the operation returns a success response without a body, otherwise the full contract data is returned.

Examples

Example 1: Retrieve all active contracts for a specific client

returnAll: true, filters: { client_id: 123 }

Example 2: Get up to 200 contracts with status 'sent'

limit: 200, filters: { status: 'sent' }

Links

Discussion