New in 0.2.x

The following endpoint will be released in version 0.2.x (part of the mobile application API update). Please check the version here before attempting to use this endpoint.

Resource URL

Returns n affiliation identified by contact id.

GET /affiliations/:id

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.

If you can't find the field you are after, you are probably thinking of a contact field. Please see the contact endpoints.

id	unsigned int	A unique id assigned to the contact
mobile	string
email	string
fax	string
position	string	e.g, Software Engineer or CEO
phone	string
postal_address	unsigned int	Postal address unique identifier
postal_address(<args>)	object	Postal address object, including any requested optional fields.
physical_address	unsigned int	Physical address unique identifier.
physical_address(<args>)	object	Physical address object.
contact	unsigned int	Contact object id. e.g, 124.
contact(<args>)	object	Contact object.
company	unsigned int	Company object id, e.g, 324
company(<args>)	object	Company object.
status	unsigned int	The contact's status id.
status(<args>)	object	The contact's status object with any optional fields.
default_affiliation	unsigned int	The contact's default affiliation id.
NEW date_modified	unix ts
NEW date_last_interacted	unix ts
NEW standing	String

Fields that can be object indicate the field can be requested as a resource. For example.

GET /affiliations/1.json?_fields=status

would return the status id. Where as,

GET /affiliations/1.json?_fields=status()

would return the status object, including any optional fields or objects within the parenthesis.

APIs

GET affiliations/:id

Handling the response