Gets a company

GET /api/company/getCompany

Gets an existing company

Query parameters

  • id string

    id of company to retrieve

Responses

  • default application/json

    Get user

    Hide response attributes Show response attributes object
    • company_address_1 string
    • company_mobile string
    • permissions object

      Additional properties are allowed.

      Hide permissions attributes Show permissions attributes object
      • view boolean
      • edit boolean
      • admin boolean
      • delete boolean
    • company_phone string
    • contact_id integer
    • sortCode string
    • leaveDate string(date)
    • 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 boolean
    • registeredOfficeAddress string
    • typeName string
    • type_id integer
    • company_email string(email)
    • joinDate string(date)
    • companyRegNo string
    • company_fax string
    • isActiveCompany boolean
    • id integer
    • modified string(date-time)
    • NMBSID string
    • company_address_3 string
    • company_address_5 string
    • score integer
GET /api/company/getCompany
curl \
 --request 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": "2025-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": "2025-05-04",
  "companyRegNo": "string",
  "company_fax": "string",
  "isActiveCompany": true,
  "id": 42,
  "modified": "2025-05-04T09:42:00Z",
  "NMBSID": "CF987",
  "company_address_3": "string",
  "company_address_5": "string",
  "score": 42
}