Introduction

An affiliation connects a contact to a company. A contact and company can have multiple affiliations. i.e, a contact has a many-to-many relationship company- affiliation maps this relationship.

Endpoints

METHOD	ENDPOINT	DESCRIPTION

METHOD	ENDPOINT	DESCRIPTION
GET	affiliations	Returns a list of Affiliations..
GET	affiliations/count	Returns the total number of affiliations.
GET	affiliations/newest	Returns a list of affiliations ordered by date_modified descending
GET	affiliations/:id	Returns an affiliation identified by its id.
GET	affiliations/:id/status	Returns an affiliation's status
DELETE	affiliations/:id	Removes an affiliation identified by its id.
POST	affiliations	Creates a new affiliation.
PUT	affiliations/:id	Updates an affiliation identified by its id.
GET	/affiliations/:id/profiles/values	Returns an array of profile values for the affiliation
PUT	/affiliations/:id/profiles/values/:profile_value_id	Update an existing profile value for the affiliation
GET	/affiliations/:id/progressions	Returns an array of available progressions for the affiliation.
[PUT\|POST]	/affiliations/:id/progressions/:progression_id/auto	Runs a status update for the given progression on the given affiliation.
GET	/affiliations/profiles/fields	Returns an array of profile fields for affiliation.
POST	/affiliations/:affiliation_id/profiles/fields/:profile_field_id	Creates a profile value for an affiliation.

Filters

These values can be used to filter through lists of affiliations. You can define filters in the _filters parameter.

standing	Array of standing status strings. For example standing(inactive,active)- filter out affiliation that do not have the supplied standing.
mobile	Only return affiliations matching the supplied mobile number(s).
fax	Only return affiliations matching the supplied fax number(s).
phone	Only return affiliations matching the supplied phone number(s).
contact_number	Only return affiliations having a mobile, phone or fax matching one of the supplied phone numbers.
NEW order_by_asc(<type>), order_by_desc(<type>)	Accepts: fullname, status, standing, date_modified and date_last_interacted
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)	Available fields: id country physical_address postal_address contact status

NOTE: filters will ignore whitespace and are generally whitelists.

Using the _not suffix (e.g, id_not) on standard in filters will returns results not in.

Affiliations

Endpoints

Filters