GET v1/admin/companies?sort={sort}

Fetches the list of companies which the person can admin

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sort

A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of GetCompaniesOutput
NameDescriptionTypeAdditional information
id

integer

None.

name

string

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "Description": "sample string 3"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "Description": "sample string 3"
  }
]

text/html

Sample:
[{"id":1,"name":"sample string 2","Description":"sample string 3"},{"id":1,"name":"sample string 2","Description":"sample string 3"}]

application/xml, text/xml

Sample:
<ArrayOfv1_Admin_CompanyEndpointController.GetCompaniesOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint">
  <v1_Admin_CompanyEndpointController.GetCompaniesOutput>
    <Description>sample string 3</Description>
    <id>1</id>
    <name>sample string 2</name>
  </v1_Admin_CompanyEndpointController.GetCompaniesOutput>
  <v1_Admin_CompanyEndpointController.GetCompaniesOutput>
    <Description>sample string 3</Description>
    <id>1</id>
    <name>sample string 2</name>
  </v1_Admin_CompanyEndpointController.GetCompaniesOutput>
</ArrayOfv1_Admin_CompanyEndpointController.GetCompaniesOutput>