NAV Navbar
shell ruby

Introduction

The EquinoxCRM API is organized around REST. An API is an application programming interface - in short, it’s a set of rules that lets programs talk to each other, exposing data and functionality across the internet in a consistent format.

REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term ‘REST API,’ they are generally referring to an API accessed via HTTP protocol at a predefined set of URLs.

Welcome to the EquinoxCRM API! You can use our API to access EquinoxCRM API endpoints, which can get information on contacts, leads and opportunities.

We have language bindings in Shell and Ruby You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

require 'equinox_crm'

@client = EquinoxCrm::Client.new("YOUR_API_KEY")
@client.contacts_list(limit: 5)
curl "http://www.equinoxcrm.com/api/public_access/contacts"
  -H "Authorization: 'YOUR_APIKEY'"

Make sure to replace YOUR_API_KEY with your API key.

The EquinoxCRM uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

EquinoxCRM expects for the API key to be included in all API requests to the server in a header.

Contacts

The contacts object

require 'equinox_crm'


@client = EquinoxCrm::Client.new("YOUR_API_KEY")
@client.contacts_list
curl "http://www.equinoxcrm.com/api/public_access/contacts"
  -H "Authorization: 'YOUR_APIKEY'"

The above command returns JSON structured like this:

[
  {
    "contact_type": "Business",
    "first_name": "Chaitanya 5",
    "middle_name": "Contact",
    "last_name": "Nyros",
    "family_name": "G",
    "full_name": "Mr Chaitanya 5 Nyros, I",
    "gender": "Male",
    "dob": "2019-08-13T18:00:00.000-06:00",
    "occupation": "Test",
    "employer": "Test",
    "marital_status": "Married",
    "marriage_anniversary": "2019-08-13T18:00:00.000-06:00",
    "web_link": "https://equinoxcrm-workspace.slack.com/",
    "web_description": "Slack",
    "employment_type": null,
    "created_at": "2019-07-31T03:21:42.481-06:00",
    "business_name": "Test",
    "federal_ein": "Test",
    "fax_number": "9494903001",
    "business_type": null,
    "objective": "Test",
    "time_horizon": 10,
    "risk_tolerance": 25,
    "exp_funds": 85,
    "exp_stocks": 55,
    "exp_partnerships": 22,
    "exp_other": 55,
    "adjusted_gross_income": 10000,
    "estimated_taxes": 20000,
    "tax_year": 200000,
    "tax_bracket": 20000,
    "total_assets": 50000,
    "liquid_assets": 5000,
    "non_liquid_assets": 500,
    "liabilities": 5000,
    "bank_name": "Test",
    "account_number": "123456789",
    "bank_address_line1": "5-106/1",
    "bank_address_line2": "Ramlaya street",
    "bank_geo_state": "AK",
    "bank_geo_city": "Adak",
    "bank_zip_code": 53301,
    "bank_country": "US",
    "routing_number": "12345678",
    "bank_phone_number": "123456798",
    "bank_fax_number": "9494903001",
    "id_type": "Ap12345678",
    "identification_number": "9494903001",
    "issue_date": "2019-08-13T18:00:00.000-06:00",
    "expiration_date": "2019-08-14T18:00:00.000-06:00",
    "identification_state": "Teest",
    "maiden_name": "Test",
    "place_of_birth": "Kakinada",
    "citizenship": "Test",
    "immigration_status": "Resident",
    "height": 5.7,
    "weight": 52.0,
    "smoking_status": "Non Smoker",
    "medical_conditions": "Good",
    "asset_name": "Test",
    "asset_type": "Automobile",
    "liability_name": "Test",
    "liability_type": "Mortgage",
    "first_review_date": "2019-08-13T18:00:00.000-06:00",
    "ima_date": "2019-08-13T18:00:00.000-06:00",
    "review": "Test",
    "written_agreements_review": "Test",
    "next_review_date": "2019-08-13T18:00:00.000-06:00",
    "signed_fee_aggrement_name": null,
    "signed_ips_aggrement_name": null,
    "latest_adv_offering": null,
    "latest_privacy_offering": null,
    "custom_fields": null,
    "cc_id": null,
    "mailchimp_id": null,
    "addresses": [{
      "address_line1": "5-106/1",
      "address_line2": "Ramlaya street",
      "country": "US",
      "geo_state": "AK",
      "geo_city": "Adak",
      "address_type": "Personal Address",
      "zip_code": 53301
    }],
    "phone_numbers": [{
      "number": "9999999999",
      "number_type": "Mobile Number",
      "state": "Current",
      "phone_number_with_code": "+19999999999"
    }],
    "emails": [{
      "address": "chaitanya.nyros@gmail.com",
      "creator_id": 17,
      "is_primary": null,
      "contact_id": 35
    }]
  }
]

Contact objects allow you to get complete information about the particular contact. This API allows you to retrieve individual contact as well as a list of all contacts.

ATTRIBUTES

Key Description
contact_type Type of the contact i.e Individual, Business, Association, Trust and Union
first_name Contact first name
middle_name Contact middle name
last_name Contact last name
family_name Contact family name
full_name Full name of the contact with suffix and salutation
gender Gives the gender
dob Gives the date of birth
occupation The contact's occupation
employer The contact's employer
marital_status Describes the martial status of the contact i.e Married, Single, Life partner, Divorced, Seperated and Widowed
marriage_anniversary The contact's marriage anniversary if he/she is married
web_link The contact's web url
web_description The contact's web description
employment_type The contact's employment type i.e Self employed and Retired
created_at Time at which the object was created
business_name Business name of the contact
federal_ein FEIN number of the contact
fax_number Fax number of the contact
business_type Business type of the contact i.e LLC, S Corp, Limited Partnership and General Partnership
objective The main object of contact's allocation model
time_horizon Allocation model time horizon
risk_tolerance Allocation model risk tolerance
exp_funds Allocation model funds
exp_stocks Allocation model stocks
exp_partnerships Allocation model partnerships
exp_other Allocation model othe things
adjusted_gross_income The contact's adjusted gross income
estimated_taxes The contact's estimated taxes
tax_year The contact's tax year
tax_bracket The contact's tax bracket
total_assets The contact's total assets
liquid_assets The contact's liquid assets
non_liquid_assets The contact's non liquid assets
liabilities The contact's liabilities
bank_name The contact's bank name
account_number The contact's bank account number
bank_address_line1 The contact's bank address line1
bank_address_line2 The contact's bank address line2
bank_geo_state The contact's bank geo state
bank_geo_city The contact's bank geo city
bank_zip_code The contact's bank zip code
bank_country The contact's bank country
routing_number The contact's bank routing number
bank_phone_number The contact's bank phone number
bank_fax_number The contact's bank fax number
id_type The contact's identification type
identification_number The contact's identification number
issue_date The contact's identification issue date
expiration_date The contact's identification expiration date
identification_state The contact's identification state
maiden_name The contact's maiden name
place_of_birth The contact's place of birth
citizenship The contact's citizenship
immigration_status The contact's citizenship i.e Resident and Non Resident
height The contact's height
weight The contact's weight
smoking_status The contact's smoking status
medical_conditions The contact's medical conditions
asset_name The contact's asset name
asset_type The contact's asset type
liability_name The contact's liability name
liability_type The contact's liability type
first_review_date The contact's client review date
ima_date The contact's client review ima date
review The contact's client review description
written_agreements_review The contact's client written agreements review
next_review_date The contact's client next review data
custom_fields The contact's additional custom fields
address_line1 The contact's address line1
address_line2 The contact's address line2
country The contact's country
geo_state The contact's geo state
geo_city The contact's geo city
address_type The contact's address type i.e Personal Address, Office Address and Mailing Address
zip_code The contact's zip code
number The contact's phone number
number_type The contact's number type i.e Mobile Number, Landline Number and Fax Number
phone_number_with_code The contact's phone number with code
address The contact's email address

List all contacts

require 'equinox_crm'

@client = EquinoxCrm::Client.new("YOUR_API_KEY")
@client.contacts_list
curl "http://www.equinoxcrm.com/api/public_access/contacts"
  -H "Authorization: 'YOUR_APIKEY'"

The above command returns JSON structured like this:

{
  "contacts": [{
    "contact_type": "Business",
    "first_name": "Chaitanya 5",
    "middle_name": "Contact",
    "last_name": "Nyros",
    "family_name": "G",
    "full_name": "Mr Chaitanya 5 Nyros, I",
    "gender": "Male",
    "dob": "2019-08-13T18:00:00.000-06:00",
    "occupation": "Test",
    "employer": "Test",
    "marital_status": "Married",
    "marriage_anniversary": "2019-08-13T18:00:00.000-06:00",
    "web_link": "https://equinoxcrm-workspace.slack.com/",
    "web_description": "Slack",
    "employment_type": null,
    "created_at": "2019-07-31T03:21:42.481-06:00",
    "business_name": "Test",
    "federal_ein": "Test",
    "fax_number": "9494903001",
    "business_type": null,
    "objective": "Test",
    "time_horizon": 10,
    "risk_tolerance": 25,
    "exp_funds": 85,
    "exp_stocks": 55,
    "exp_partnerships": 22,
    "exp_other": 55,
    "adjusted_gross_income": 10000,
    "estimated_taxes": 20000,
    "tax_year": 200000,
    "tax_bracket": 20000,
    "total_assets": 50000,
    "liquid_assets": 5000,
    "non_liquid_assets": 500,
    "liabilities": 5000,
    "bank_name": "Test",
    "account_number": "123456789",
    "bank_address_line1": "5-106/1",
    "bank_address_line2": "Ramlaya street",
    "bank_geo_state": "AK",
    "bank_geo_city": "Adak",
    "bank_zip_code": 53301,
    "bank_country": "US",
    "routing_number": "12345678",
    "bank_phone_number": "123456798",
    "bank_fax_number": "9494903001",
    "id_type": "Ap12345678",
    "identification_number": "9494903001",
    "issue_date": "2019-08-13T18:00:00.000-06:00",
    "expiration_date": "2019-08-14T18:00:00.000-06:00",
    "identification_state": "Teest",
    "maiden_name": "Test",
    "place_of_birth": "Kakinada",
    "citizenship": "Test",
    "immigration_status": "Resident",
    "height": 5.7,
    "weight": 52.0,
    "smoking_status": "Non Smoker",
    "medical_conditions": "Good",
    "asset_name": "Test",
    "asset_type": "Automobile",
    "liability_name": "Test",
    "liability_type": "Mortgage",
    "first_review_date": "2019-08-13T18:00:00.000-06:00",
    "ima_date": "2019-08-13T18:00:00.000-06:00",
    "review": "Test",
    "written_agreements_review": "Test",
    "next_review_date": "2019-08-13T18:00:00.000-06:00",
    "signed_fee_aggrement_name": null,
    "signed_ips_aggrement_name": null,
    "latest_adv_offering": null,
    "latest_privacy_offering": null,
    "custom_fields": null,
    "cc_id": null,
    "mailchimp_id": null,
    "addresses": [{
      "address_line1": "5-106/1",
      "address_line2": "Ramlaya street",
      "country": "US",
      "geo_state": "AK",
      "geo_city": "Adak",
      "address_type": "Personal Address",
      "zip_code": 53301
    }],
    "phone_numbers": [{
      "number": "9999999999",
      "number_type": "Mobile Number",
      "state": "Current",
      "phone_number_with_code": "+19999999999"
    }],
    "emails": [{
      "address": "chaitanya.nyros@gmail.com",
      "creator_id": 17,
      "is_primary": null,
      "contact_id": 35
    }]
    },
    {
      "contact_type": "Business",
      "first_name": "Varma",
      "middle_name": "Contact",
      "last_name": "Nyros",
      "family_name": "G",
      "full_name": "Mr Varma 5 Nyros, I",
      "gender": "Male",
      "dob": "2019-08-13T18:00:00.000-06:00",
      "occupation": "Test",
      "employer": "Test",
      "marital_status": "Married",
      "marriage_anniversary": "2019-08-13T18:00:00.000-06:00",
      "web_link": "https://equinoxcrm-workspace.slack.com/",
      "web_description": "Slack",
      "employment_type": null,
      "created_at": "2019-07-31T03:21:42.481-06:00",
      "business_name": "Test",
      "federal_ein": "Test",
      "fax_number": "9494903001",
      "business_type": null,
      "objective": "Test",
      "time_horizon": 10,
      "risk_tolerance": 25,
      "exp_funds": 85,
      "exp_stocks": 55,
      "exp_partnerships": 22,
      "exp_other": 55,
      "adjusted_gross_income": 10000,
      "estimated_taxes": 20000,
      "tax_year": 200000,
      "tax_bracket": 20000,
      "total_assets": 50000,
      "liquid_assets": 5000,
      "non_liquid_assets": 500,
      "liabilities": 5000,
      "bank_name": "Test",
      "account_number": "123456789",
      "bank_address_line1": "5-106/1",
      "bank_address_line2": "Ramlaya street",
      "bank_geo_state": "AK",
      "bank_geo_city": "Adak",
      "bank_zip_code": 53301,
      "bank_country": "US",
      "routing_number": "12345678",
      "bank_phone_number": "123456798",
      "bank_fax_number": "9494903001",
      "id_type": "Ap12345678",
      "identification_number": "9494903001",
      "issue_date": "2019-08-13T18:00:00.000-06:00",
      "expiration_date": "2019-08-14T18:00:00.000-06:00",
      "identification_state": "Teest",
      "maiden_name": "Test",
      "place_of_birth": "Kakinada",
      "citizenship": "Test",
      "immigration_status": "Resident",
      "height": 5.7,
      "weight": 52.0,
      "smoking_status": "Non Smoker",
      "medical_conditions": "Good",
      "asset_name": "Test",
      "asset_type": "Automobile",
      "liability_name": "Test",
      "liability_type": "Mortgage",
      "first_review_date": "2019-08-13T18:00:00.000-06:00",
      "ima_date": "2019-08-13T18:00:00.000-06:00",
      "review": "Test",
      "written_agreements_review": "Test",
      "next_review_date": "2019-08-13T18:00:00.000-06:00",
      "signed_fee_aggrement_name": null,
      "signed_ips_aggrement_name": null,
      "latest_adv_offering": null,
      "latest_privacy_offering": null,
      "custom_fields": null,
      "cc_id": null,
      "mailchimp_id": null,
      "addresses": [{
        "address_line1": "5-106/1",
        "address_line2": "Ramlaya street",
        "country": "US",
        "geo_state": "AK",
        "geo_city": "Adak",
        "address_type": "Personal Address",
        "zip_code": 53301
      }],
      "phone_numbers": [{
        "number": "9999999999",
        "number_type": "Mobile Number",
        "state": "Current",
        "phone_number_with_code": "+19999999999"
      }],
      "emails": [{
        "address": "chaitanya.nyros@gmail.com",
        "creator_id": 17,
        "is_primary": null,
        "contact_id": 35
      }]
    }
  ],
  "page_details": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "total_pages": 11,
    "total_count": 21
  }
}

Returns a list of your contacts. The contacts are returned sorted by creation date, with the most recent contacts appearing first.

Query Parameters

Parameter Description
limit optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
email optional A filter on the list based on the contacts’s email field. The value must be a string.

Retrive a contact

require 'equinox_crm'

@client = EquinoxCrm::Client.new("YOUR_API_KEY")
@client.contacts('ID')
curl "http://www.equinoxcrm.com/api/public_access/contacts/ID"
  -H "Authorization: 'YOUR_APIKEY'"

The above command returns JSON structured like this:

[
  {
    "contact_type": "Business",
    "first_name": "Chaitanya 5",
    "middle_name": "Contact",
    "last_name": "Nyros",
    "family_name": "G",
    "full_name": "Mr Chaitanya 5 Nyros, I",
    "gender": "Male",
    "dob": "2019-08-13T18:00:00.000-06:00",
    "occupation": "Test",
    "employer": "Test",
    "marital_status": "Married",
    "marriage_anniversary": "2019-08-13T18:00:00.000-06:00",
    "web_link": "https://equinoxcrm-workspace.slack.com/",
    "web_description": "Slack",
    "employment_type": null,
    "created_at": "2019-07-31T03:21:42.481-06:00",
    "business_name": "Test",
    "federal_ein": "Test",
    "fax_number": "9494903001",
    "business_type": null,
    "objective": "Test",
    "time_horizon": 10,
    "risk_tolerance": 25,
    "exp_funds": 85,
    "exp_stocks": 55,
    "exp_partnerships": 22,
    "exp_other": 55,
    "adjusted_gross_income": 10000,
    "estimated_taxes": 20000,
    "tax_year": 200000,
    "tax_bracket": 20000,
    "total_assets": 50000,
    "liquid_assets": 5000,
    "non_liquid_assets": 500,
    "liabilities": 5000,
    "bank_name": "Test",
    "account_number": "123456789",
    "bank_address_line1": "5-106/1",
    "bank_address_line2": "Ramlaya street",
    "bank_geo_state": "AK",
    "bank_geo_city": "Adak",
    "bank_zip_code": 53301,
    "bank_country": "US",
    "routing_number": "12345678",
    "bank_phone_number": "123456798",
    "bank_fax_number": "9494903001",
    "id_type": "Ap12345678",
    "identification_number": "9494903001",
    "issue_date": "2019-08-13T18:00:00.000-06:00",
    "expiration_date": "2019-08-14T18:00:00.000-06:00",
    "identification_state": "Teest",
    "maiden_name": "Test",
    "place_of_birth": "Kakinada",
    "citizenship": "Test",
    "immigration_status": "Resident",
    "height": 5.7,
    "weight": 52.0,
    "smoking_status": "Non Smoker",
    "medical_conditions": "Good",
    "asset_name": "Test",
    "asset_type": "Automobile",
    "liability_name": "Test",
    "liability_type": "Mortgage",
    "first_review_date": "2019-08-13T18:00:00.000-06:00",
    "ima_date": "2019-08-13T18:00:00.000-06:00",
    "review": "Test",
    "written_agreements_review": "Test",
    "next_review_date": "2019-08-13T18:00:00.000-06:00",
    "signed_fee_aggrement_name": null,
    "signed_ips_aggrement_name": null,
    "latest_adv_offering": null,
    "latest_privacy_offering": null,
    "custom_fields": null,
    "cc_id": null,
    "mailchimp_id": null,
    "addresses": [{
      "address_line1": "5-106/1",
      "address_line2": "Ramlaya street",
      "country": "US",
      "geo_state": "AK",
      "geo_city": "Adak",
      "address_type": "Personal Address",
      "zip_code": 53301
    }],
    "phone_numbers": [{
      "number": "9999999999",
      "number_type": "Mobile Number",
      "state": "Current",
      "phone_number_with_code": "+19999999999"
    }],
    "emails": [{
      "address": "chaitanya.nyros@gmail.com",
      "creator_id": 17,
      "is_primary": null,
      "contact_id": 35
    }]
  }
]

Retrieves the details of an existing contact. You need only supply the unique contact identifier that was returned upon contact creation.

Query Parameters

Parameter Description
id The identifier of the contact to be retrieved.

Errors

The The EquinoxCRM API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The EquinoxCRM requested is hidden for administrators only.
404 Not Found -- The specified EquinoxCRM could not be found.
405 Method Not Allowed -- You tried to access a EquinoxCRM with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The EquinoxCRM requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.