Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Companies Structure → Get List

AI-generated

Summary

Retrieve a list of companies from Acumatica with optional OData $filter filtering.

Inputs

  • customFilter — Advanced OData $filter expression (e.g. CustomerID/value eq 'CUST001'). Appended as a query parameter to the API request. Applied in addition to any default filter fields for this resource and operation.

Output shape

Array of company records from the Acumatica Companies dataset. Exact field shape determined by the Acumatica OpenAPI schema for the Companies resource.

The operation issues a GET request to the Acumatica default endpoint path with the Companies resource. The customFilter parameter constructs the $filter query string. All generated filter UI fields have displayOptions restricting them to the getList operation only.

Examples

Example 1: Fetch all companies

Leave customFilter empty.

Example 2: Fetch companies filtered by CustomerID

Set customFilter to CustomerID/value eq 'CUST001'.

Links

Discussion