Resource URL
/companies/:id
Parameters
Table of allowed paramaters.
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
|---|
Handling the response
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields paramater; see included examples. Underlined values are default.
| id | unsigned int | |
|---|---|---|
| name | string | |
| website | string | |
| standing | string | |
| status | unsigned int or object | |
| phone | string | |
| fax | string | |
| date_created | unsigned int | |
| date_modified | unsigned int | |
| comments | string | |
| contact | unsigned int or object |
Fields that can be object indicate the field can be requested as a resource. For example.
GET /companies/10.json?_fields=contact
would return the contacts id. Where as,
GET /companies/10.json?_fields=contact()
would return the contact's object, including any optional fields or objects within the parenthesis.
Sample Response
GET /companies.json?_fields=contact(),standing
{
"response" : {
"name" : "Balgownie Veterinary Hospital",
"contact" : {
"email" : "mark@balgownievet.com.au",
"firstname" : "Mark",
"id" : "2",
"mobile" : "",
"surname" : "Allison"
},
"standing" : "active",
"id" : "2"
},
"meta" : {
"more_info" : "/public_api/docs/status/ok",
"status" : "ok",
"message" : "Everything executed as expected."
}
}