Resource URL

Returns the status object for a given company

GET /companies/:id/status

Parameters

Table of allowed parameters.

_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 parameter; see included examples. Underlined values are default.

id	unsigned int	A unique id for the status
title	string	The status title
color	string	The string representation of the color. e.g, red or green.
standing	string	The status standing. e.g, active or inactive.
start	unsigned int

Sample Response

GET /companies/1/status.json

{
   "response" : {
      "title" : "Active",
      "id" : "3"
   },
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}