Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Company Management

List all companies

List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View companies (company:read)Manage companies (company:write)
get/v1/companies

Query parameters

external_idstring

External ID

Headers

Authorizationstring required

Requires a client credentials access token obtained through the Client Credentials flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Client Credentials flow.

Response

Success

Example response

{
  "data": {
    "companies": [
      {
        "address_details": {
          "address": "1709 Broderick St",
          "address_line_2": "Flat number 123",
          "city": "San Francisco",
          "postal_code": "94115",
          "state": "CA"
        },
        "bank_account_details": {
          "account_holder": "Joe Smith",
          "account_number": "31234123123",
          "account_type": "savings",
          "name": "Bank name",
          "ownership_type": "BUSINESS",
          "routing_number": "123124123"
        },
        "company_owner_email": "te@remote.com",
        "company_owner_name": "Joe Smith",
        "company_owner_user_id": "75619adf-8775-4531-9e7d-5b2cbabdc1a8",
        "country_code": "USA",
        "created_at": "2021-07-15T18:18:17Z",
        "default_legal_entity_credit_risk_status": "no_deposit_required",
        "desired_currency": "USD",
        "external_id": "00001111",
        "id": "e5a8b061-company-id-4c5c81ac885e",
        "name": "Your Company Name",
        "phone_number": "+1123123456",
        "status": "active",
        "terms_of_service_accepted_at": "2021-10-29T12:39:15Z",
        "updated_at": "2021-07-15T18:18:17Z"
      }
    ]
  }
}