HEhellozai
Companies

List Companies

Retrieve an ordered and paginated list of existing Companies.

get/companies

Request

  • Base URL
    https://test.api.promisepay.com
  • URL
    https://test.api.promisepay.com/companies
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://au-0000.sandbox.auth.assemblypay.com/tokens

Query parameters

limitinteger

Number of records to retrieve. Up to 200.

offsetinteger

Number of records to offset. Required for pagination.

Response

OK

Example response

{
  "companies": [
    {
      "id": "9280aa36-d7f8-4959-b1ed-0ace2c12cfa2",
      "name": "Assembly Payments",
      "legal_name": "PromisePay",
      "business_email": "test@email.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.