Gets companies

GET /api/company/getCompanyOfType

Gets a list of companies by type

Query parameters

search.value string

Query to filter results
typeid string

Type of company
length string

Number of records to return
start string

start row for resultset

Responses

default application/json

Get user
Hide response attributes Show response attributes object
- contact array[object]
  
  Hide contact attributes Show contact attributes object
  
  surname string
  
  first_name string
  
  id integer
  
  email string(email)
- COMPANY_ADDRESS_1 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 string
- COMPANY_ADDRESS_4 string
- COMPANY_POSTCODE string
- COMPANY_PHONE_2 string
- COMPANYID integer
- COMPANY_ADDRESS_2 string
- KNOWN_AS string
- NAME string
- COMPANY_ADDRESS_3 string
- COMPANY_ADDRESS_5 string

GET /api/company/getCompanyOfType

curl \
 --request GET 'http://api.example.com/api/company/getCompanyOfType'

Response examples (default)

[
  {
    "contact": [
      {
        "surname": "string",
        "first_name": "string",
        "id": 42,
        "email": "hello@example.com"
      }
    ],
    "COMPANY_ADDRESS_1": "string",
    "permissions": {
      "view": true,
      "edit": false,
      "admin": false,
      "delete": false
    },
    "COMPANY_PHONE": "string",
    "CONTACT_ID": "string",
    "COMPANY_ADDRESS_4": "string",
    "COMPANY_POSTCODE": "string",
    "COMPANY_PHONE_2": "string",
    "COMPANYID": 42,
    "COMPANY_ADDRESS_2": "string",
    "KNOWN_AS": "string",
    "NAME": "string",
    "COMPANY_ADDRESS_3": "string",
    "COMPANY_ADDRESS_5": "string"
  }
]