PApaperlessparts
Customers

List accounts

Returns a list of accounts. The accounts are returned 20 results at a time and can be iterated over by using the page parameter.

get/accounts/public

Request

Query parameters

searchstring

Value used to search against the following fields: account name, erp code, notes, and id. Comparisons are not case sensitive and will match when the field value includes the search value as a substring.

pagestring

The page of results to return.

erp_codestring

The erp code of the accounts to return. Must be an exact match.

null_erp_codeboolean

Filters for accounts whose erp code is either null or an empty string.

Response

Successful response

namestring

The name of the account

erp_codestring

The ERP code of the account

idinteger

the ID of the account

phonestring

Account phone number

phone_extstring

Account phone number extension

typestring

Account type, either customer or vendor

Example response

[
  {
    "name": "Paperless Parts, Inc.",
    "erp_code": "PPI",
    "id": 17,
    "phone": "6176354500",
    "type": "customer"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.