Actions30
Counterparty → Get Many
AI-generatedSummary
Retrieve multiple counterparties from the MoySklad API.
Inputs
- additionalOptions — Collection of optional parameters to refine the request.
- expand — Comma-separated relations to expand.
- filters — Semicolon-separated filters for querying, supports custom fields.
- limit — Maximum number of records to retrieve (default: 100, max: 1000).
- offset — Pagination offset (default: 0).
Output shape
a list of counterparties
Returns an array of counterparty records; includes optional expanded relations if specified.
Examples
Example 1: Retrieve counterparties limited to 50, with a filter applied to a custom field.
Set additionalOptions limit to 50 and filters to 'attributes.name=value'.
Example 2: Fetch all counterparties with expanded relations for detailed view.
Set additionalOptions expand to 'contacts,addresses'.