GET/companies.json

Retrieve Companies

The requesting user is returned a list of companies available to them.


Query Params

  • Name
    page
    Type
    integer
    Description
    Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize. For example: ?page=2&pageSize=10 will retrieve results 10-20.
  • Name
    pageSize
    Type
    integer
    Description
    The amount of companies returned can be limited using this parameter. Normally used in conjunction with the page parameter

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "companies": [
    {
      "state": "State",
      "name": "Demo 2 Company",
      "address_two": "Address Line 2",
      "email_one": "",
      "country": "Ireland",
      "isowner": "0",
      "email_three": "",
      "contacts": "0",
      "industry": "",
      "logo-URL": "",
      "address_one": "Address Line 1",
      "website": "http://demo2company.com",
      "cid": "",
      "email_two": "",
      "accounts": "0",
      "phone": "",
      "company_name_url": "999-demo-2-company",
      "countrycode": "IE",
      "can_see_private": false,
      "zip": "",
      "id": "999",
      "city": "City",
      "fax": ""
    }
  ]
}