Acumatica API - Custom Endpoint icon

Acumatica API - Custom Endpoint

Interact with a custom Acumatica endpoint (schema fetched from the instance)

Actions7

Get List

AI-generated

Summary

Retrieve a list of records from a specified Acumatica endpoint and version, supporting optional filtering, field selection, expansion of linked entities, and inclusion of custom fields. Supports pagination to return either all records or a limited number.

Inputs

  • Endpoint Name (required) — The Acumatica endpoint name to query, such as 'Default' or 'JMS.CRM'.
  • Endpoint Version (required) — The version of the Acumatica endpoint, e.g., '24.200.001' or '1.0'.
  • Return All — Whether to return all matching records by paging through results (true), or limit the number of records returned (false).
  • Limit — The maximum number of records to return when 'Return All' is false; minimum is 1.
  • Query Parameters — Optional OData-style query parameters to customize the retrieved data, including:
  • '$filter': conditions to select records
  • '$select': specific fields of the entity to return
  • '$expand': linked and detail entities to expand for nested data
  • '$custom': custom non-contract fields to include, specified like 'ItemSettings.UsrRepairItemType' or 'Document/DocumentSettings.UsrField'.

Output shape

a list of JSON objects each representing a record retrieved from the Acumatica endpoint

If 'Return All' is true, the operation pages through results using batches of up to 200 records until no more data is available. If false, it returns up to the specified 'Limit'. Each output item contains the record JSON and is paired with the originating input item index. Errors return JSON with an error message and paired item. The query parameters allow precise control over the returned dataset.

Links

Discussion