Query Companies
List of paths to query for all companies across an application.
Note: /v1.0/admin
path requires a client_credential
grant access token.
#
Methods & PathsMethod | URI | Name | Summary |
---|---|---|---|
GET | /v1.0/admin/companies | Company | Retrieve all companies for current application |
GET | /v1.0/admin/companies/{company_id} | Company List | Retrieve a company |
GET | /v1.0/admin/companies/count | Company Count | Count all companies for current application |
POST | /v1.0/admin/companies | Company Create | Create a company in the current application |
PUT | /v1.0/admin/companies/{company_id} | Company Update | Update a company from the current application |
DELETE | /v1.0/admin/companies/{company_id} | Company Delete | Delete a company from the current application |
#
Query ParametersName | Source | Type |
---|---|---|
application_id | query | string |
limit | query | number |
page | query | number |
user_id | query | string |
external_id | query | string |
#
ResponsesCode | Status | Description | Has headers | Schema |
---|---|---|---|---|
200 | OK | Successful company retrieval | schema | |
400 | Bad Request | Bad request sent to server | schema | |
401 | Unauthorized | You are unauthorized | schema | |
403 | Forbidden | You are forbidden to perform this action | schema |
#
Company ModelName | Type | Required | Example |
---|---|---|---|
address | string | โ | 3900 W Alameda Ave |
application_id | string | uuid | |
city | string | โ | Burbank |
country | string | โ | USA |
created_at | date (formatted string) | 1970-01-01T00:00:00.000Z | |
id | number | 1 | |
industry | string | โ | [\"IoT\"] |
latitude | number | 34.1526642 | |
longitude | number | -118.3428161 | |
name | string | โ | My Company |
state | string | CA | |
status | number | 0 | |
timezone | string | America/Los_Angeles | |
updated_at | date (formatted string) | 1970-01-01T00:00:00.000Z | |
user_id | string | uuid | |
zip | string | โ | 91505 |
#
Example 1List all Companies within your domain
We will use the token obtained in the previous call and use it to list all companies within our domain.
Remember to use the access token obtained from the OAuth call when making any queries.
Example Response:
#
Example 2Create a Company
Example Response:
#
Example 3Update a company
Example Response:
#
Example 4Delete a Company
Example Response:
#
Example 5Get Company by External Id