List companies

GET/client_api/v2/companies

For resellers. The client companies you can see.

Parameters

No parameters.

Returns

Returns a list of companies.

Errors

• 401Unauthorized
  The token is missing, expired or invalid. Sign in again.

View as Markdown

GET /client_api/v2/companies

cURLJavaScriptPythonPHPC#Ruby

1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/companies" \
2  -H "Authorization: Bearer $API_TOKEN"

Response200 OK401 Unauthorized

{
  "companies": [
    {
      "id": 9,
      "account_number": "MYSGLO001",
      "account_status": "active",
      "address": {
        "id": 143,
        "address_1": "14 Bree Street",
        "address_2": "Unit 3",
        "address_3": null,
        "city": "Cape Town",
        "classification": "business",
        "company": "Global Trade Corp",
        "country_id": 20,
        "email": "dispatch@globaltradecorp.example",
        "import_code": null,
        "latitude": null,
        "longitude": null,
        "name": "Thandi Mokoena",
        "phone": "+27215550142",
        "postal_code": "8001",
        "province": "Western Cape",
        "summary": "South Africa",
        "tax_number": null,
        "time_zone_id": null
      },
      "api_users": [
        {
          "id": 13,
          "email": "integrations@globaltradecorp.example",
          "identity": "Thandi Mokoena"
        }
      ],
      "code": "MYSGLO001",
      "company_billing": true,
      "currency_id": "ZAR",
      "name": "Global Trade Corp"
    },
    {
      "id": 10,
      "account_number": "MYSKAR001",
      "account_status": "active",
      "address": {
        "id": 146,
        "address_1": "8 Church Street",
        "address_2": null,
        "address_3": null,
        "city": "Prince Albert",
        "classification": "business",
        "company": "Karoo Leather Works",
        "country_id": 20,
        "email": "pieter@karooleather.example",
        "import_code": null,
        "latitude": null,
        "longitude": null,
        "name": "Pieter van Wyk",
        "phone": "+27235550198",
        "postal_code": "6930",
        "province": "Western Cape",
        "summary": "South Africa",
        "tax_number": null,
        "time_zone_id": null
      },
      "api_users": [
        {
          "id": 14,
          "email": "admin@karooleather.example",
          "identity": "admin@karooleather.example"
        }
      ],
      "code": "MYSKAR001",
      "company_billing": true,
      "currency_id": "ZAR",
      "name": "Karoo Leather Works"
    }
  ],
  "meta": {
    "page_count": 1,
    "record_count": 2
  }
}