Companies

List Companies

Get a list of all companies for a team

GET
/api/v1/companies

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Query Parameters

enterpriseNumber?string

Filter companies by enterprise number

vatNumber?string

Filter companies by VAT number

Response Body

application/json

application/json

curl -X GET "https://app.recommand.eu/api/v1/companies"
{
  "success": true,
  "companies": [
    {
      "id": "string",
      "teamId": "string",
      "name": "string",
      "address": "string",
      "postalCode": "string",
      "city": "string",
      "country": "string",
      "enterpriseNumberScheme": "string",
      "enterpriseNumber": "string",
      "vatNumber": "string",
      "email": "string",
      "phone": "string",
      "isSmpRecipient": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}