Introduction

Companies are the entries in AffinityLive where you note the companies whom you provide services to. These can range from partners and vendors to your actual customers, and can even include you! These Client entries also act as the central repository for all information related to that group, including correspondence, project and sales updates, and contact information for their employees.

Endpoints

METHOD	ENDPOINT	DESCRIPTION

METHOD	ENDPOINT	DESCRIPTION
POST	companies	Creates a new company resource.
PUT	companies/:id	Update a company resource identified by company_id.
DELETE	companies/:id	Delete a company resource identified by company_id.
GET	companies	Returns an array of 10 companies.
GET	companies/count	Returns the total count of companies under your deployment.
GET	companies/recent	Returns the 10 most recent (last created) companies.
GET	companies/newest	Returns the 10 newest companies (last modified).
GET	companies/:id	Returns a company resource for a given company_id.
GET	companies/:id/status	Returns a companies status for a given company_id.
GET	companies/:company_id/contact	Returns the main contact for a company identified by company_id.
GET	companies/:company_id/contact/status	Returns the main contacts status for a company identified by company_id.
GET	companies/:id/contacts	Returns an array of 10 contacts for company identified by company_id.
GET	companies/:id/managers	Returns an array of staff member managers for a given company.
POST	companies/:id/managers/add	Creates a manager relationship with the company and returns the list of managers for the company.
DELETE	companies/:id/managers/delete	Removes a manager relationship from the company and returns the list of managers for the company.
GET	companies/:id/contacts/count	Returns the total count of contacts for company identified by company_id.
GET	companies/:id/segmentations	Returns an array of company segmentations/profile fields.
GET	/companies/:id/profiles/values	Returns an array of profile values for the company
PUT	/companies/:id/profiles/values/:profile_value_id	Update an existing profile value for the company
GET	/companies/:id/progressions	Returns an array of available progressions for the company.
[PUT\|POST]	/companies/:id/progressions/:progression_id/auto	Runs a status update for the given progression on the given company.
GET	/companies/profiles/fields	Returns an array of profile fields for company.
POST	/companies/:company_id/profiles/fields/:profile_field_id	Creates a profile value for a company.
GET	/companies/:company_id/addresses	Returns a list of address for a company
GET	/companies/:company_id/collections	Returns a list of resource collections for the given company.
POST	/companies/:company_id/collections/:collection_id/resources	Uploads resource (attachment) to the given collection.
POST	/companies/:company_id/addresses	Creates a new address for given company