Skip to main content

​
Overview

The /company/list endpoint returns all companies associated with your integration. Use it to look up company IDs, verify which companies are connected, or synchronize your system with SynchPay.

​
How it works

1

Obtain an access token

Request an access token by calling /auth/token with your ClientId and ClientSecret. Refer to the Authorization section for details.
2

Call the endpoint

Make a GET request to /company/list with your access token. No additional parameters are required — the endpoint returns every company linked to your integration.
3

Process the results

The response contains an array of company objects, each with an id, name, and optional referenceId.

​
Retrieving your companies

​
Endpoint

  • URL: https://api.synchpay.com/company/list
  • Method: GET
  • Authorization: Bearer <AccessToken>
This endpoint requires no query parameters or request body.

​
Response

The response contains a single companies array:
PropertyTypeDescription
idstringThe unique identifier for the company.
namestringThe company name provided during registration.
referenceIdstringThe custom reference ID assigned to the company, if one was set. Can be null.

​
Example request

GET /company/list HTTP/1.1
Host: api.synchpay.com
Authorization: Bearer eyJhbGciOi...

​
Example response

{
  "companies": [
    {
      "id": "0ba2d920-7588-407f-8553-afc4f073c9b8",
      "name": "Downtown Fitness",
      "referenceId": "loc-001"
    },
    {
      "id": "7c3e1a45-92fd-4b10-a6df-8e5d4f2c1b09",
      "name": "Uptown Wellness",
      "referenceId": null
    }
  ]
}

​
When to use this endpoint

  • Syncing company data — Keep your system up to date with the companies registered in SynchPay.
  • Looking up company IDs — Find the id for a specific company before calling other endpoints such as /company/{companyId}/status or /transaction/report.
  • Verifying registrations — Confirm that a company was successfully created after calling /company/create.