ROroutable
Companies

List Companies

Changed on

Returns a list of previously created Companies.

get/v1/companies

Request

Query parameters

pageinteger

Retrieve a specific page of a List.

page_sizeinteger

Set the number of results per page of a List.

customer_idstring

Filter for Companies with the given customer_id in your accounting software.

external_idstring

Filter for Companies with the given external_id

searchstring

Search across display_name and business_name.

statusCompaniesStatus[]

Filter for Companies with one of the given statuses.

vendor_idstring

Filter for Companies with the given vendor_id in your accounting software.

tax_form_statusSharedTaxFormStatus[]

Filter for Companies with one of the given tax form statuses.

Response

OK

object'List' required

The object’s type (List).

Changes

  • 9d71f3ec4b5cRevision changes
    • info

      the /////////// response's property pattern was changed from ^\+?[1-9]\d{1,14}$ to ^\+[1-9]\d{1,14}$ for the status