Gets a company

GET /api/company/getCompany

Gets an existing company

Query parameters

  • id string

    id of company to retrieve

Responses

GET /api/company/getCompany
curl \
 -X GET http://api.example.com/api/company/getCompany
Response examples (default)
{
  "company_address_1": "string",
  "company_mobile": "string",
  "permissions": {
    "view": true,
    "edit": false,
    "admin": false,
    "delete": false
  },
  "company_phone": "string",
  "contact_id": 42,
  "sortCode": "string",
  "leaveDate": "2024-05-04",
  "accountNumber": "string",
  "company_address_4": "string",
  "company_website": "string",
  "company_postcode": "string",
  "company_phone_2": "string",
  "VATNumber": "string",
  "company_address_2": "string",
  "known_as": "string",
  "name": "string",
  "company_contact": "string",
  "description": "string",
  "automateProfiles": false,
  "registeredOfficeAddress": "string",
  "typeName": "Supplier",
  "type_id": 2,
  "company_email": "hello@example.com",
  "joinDate": "2024-05-04",
  "companyRegNo": "string",
  "company_fax": "string",
  "isActiveCompany": true,
  "id": 42,
  "modified": "2024-05-04T09:42:00+00:00",
  "NMBSID": "CF987",
  "company_address_3": "string",
  "company_address_5": "string",
  "score": 42
}