API Docs

Learn How to Connect Your Website, App and Data to Gro CRM With Our Developer API Documentation

Gro CRM Rest API
Eat. Sleep. Code.

Contacts
  1. Properties
  2. Get all contacts
  3. Get associated contacts
  4. Get associated deals
  5. Get associated tasks
  6. Create an individual
  7. Create an account
  8. Get an individual
  9. Get an account
  10. Update an individual
  11. Update an account
  12. Delete a contact
  13. Types
About the Contacts API

The contacts API allows you to access information about your current contacts and accounts. You can also update contact information or create new contacts

Properties
Name Type Description
id integer The unique id of the contact. Read only
type_id integer ID of the contact type. For more information see Types
is_account boolean Indicator of whether or not this contact is an account or an individual contact. This can only be set during creation of an account.
account dictionary The information for the attached contact. This property will only be set if the contact is an individual and if the contact has an associated account. Read only
name string The contact's name. If the contact is an individual it will be their full name.
first_name string The contact's first name. Individual contacts only.
last_name string The contact's last name. Individual contacts only.
title string The contact's title. This property will only be set if the contact is an individual.
role string The contact's role. This property will only be set if the contact is an individual.
address string The contact's address.
address2 string The contact's secondary address.
city string The contact's city.
state string The contact's state.
postal_code string The contact's postal code.
country_id integer The id of the contact's country. See more at Globals.
timezone_id integer The id of the contact's timezone. See more at Globals.
currency_id integer The id of the contact's currency. See more at Globals.
email string The contact's email address.
phone string The contact's phone number.
mobile string The contact's mobile phone number.
fax string The contact's fax number.
imessage string The contact's iMessage phone number or email address.
facetime string The contact's FaceTime phone number or email address.
website string The contact's website address.
facebook string The contact's Facebook username.
twitter string The contact's Twitter username.
linkedin string The contact's LinkedIn username.
tags array The contact's tags.
notes string Associated notes.
created_at string Date and time that the contact was created in ISO8601 format. Read Only
updated_at string Date and time that the contact was last updated in ISO8601 format. Read Only
Get all contacts

List all of the contacts that are available to the authenticated user.

Parameters
Name Type Description
page number Page number to start from. Default is 1.
ex. ?page=1
per_page number Number of items to retrieve per page. Default is 20. Max is 40.
ex. ?per_page=10
sort string Can be created, updated, name. Default updated.
ex. ?sort=name
order string Can be asc or desc. Default desc.
ex. ?order=asc
search string The search keywords.
ex. ?search=ceo
Curl Example
Response Headers
Response Body
Get associated contacts

List contacts that are associated with an account.

Parameters
Name Type Description
page number Page number to start from. Default is 1.
ex. ?page=1
per_page number Number of items to retrieve per page. Default is 20. Max is 40.
ex. ?per_page=10
sort string Can be created, updated, name. Default updated.
ex. ?sort=created
order string Can be asc or desc. Default desc.
ex. ?order=asc
search string The search keywords.
ex. ?search=executive
Curl Example
Response Headers
Response Body
Get associated deals
Parameters
Name Type Description
page number Page number to start from. Default is 1.
ex. ?page=1
per_page number Number of items to retrieve per page. Default is 20. Max is 40.
ex. ?per_page=10
sort string Can be created, updated, name. Default updated.
ex. ?sort=created
order string Can be asc or desc. Default desc.
ex. ?order=asc
search string The search keywords.
ex. ?search=executive
Curl Example
Response Headers
Response Body
Get associated tasks
Parameters
Name Type Description
page number Page number to start from. Default is 1.
ex. ?page=1
per_page number Number of items to retrieve per page. Default is 20. Max is 40.
ex. ?per_page=10
sort string Can be created, updated, name. Default updated.
ex. ?sort=created
order string Can be asc or desc. Default desc.
ex. ?order=asc
search string The search keywords.
ex. ?search=executive
Curl Example
Response Headers
Response Body
Create an individual
Parameters
Name Type Description
type_id integer ID of the contact type. Required For more information see Types
ex. "type_id": 1
is_account boolean Indicator of whether or not this contact is an account or an individual contact. This can only be set during creation of an account.
ex. "is_account": false
account_id integer The unique id of the associated account.
ex. "account_id": 10000015
first_name string The contact's first name. Individual contacts only. Required
ex. "first_name": "Ethan"
last_name string The contact's last name. Individual contacts only. Required
ex. "last_name": "Black"
title string The contact's title. This property will only be set if the contact is an individual.
ex. "title": "CEO"
role string The contact's role. This property will only be set if the contact is an individual.
ex. "role": "Sales"
address string The contact's address.
ex. "address": "101 America Street"
address2 string The contact's secondary address.
ex. "address2": "Suite 2601"
city string The contact's city.
ex. "city": "San Francisco"
state string The contact's state.
ex. "state": "CA"
postal_code string The contact's postal code.
ex. "postal_code": "94111"
country_id integer The id of the contact's country. See more at Globals.
ex. "country_id": 188
timezone_id integer The id of the contact's timezone. See more at Globals.
ex. "timezone_id": 135
currency_id integer The id of the contact's currency. See more at Globals.
ex. "currency_id": 1
email string The contact's email address.
ex. "email": "noah@apple.com"
phone string The contact's phone number.
ex. "phone": "(628) 555-1234"
mobile string The contact's mobile phone number.
ex. "mobile": "(628) 555-1234"
fax string The contact's fax number.
ex. "fax": "(628) 555-1234"
imessage string The contact's iMessage phone number or email address.
ex. "imessage": "noah@icloud.com"
facetime string The contact's FaceTime phone number or email address.
ex. "facetime": "noah@icloud.com"
website string The contact's website address.
ex. "website": "https://www.apple.com"
facebook string The contact's Facebook username.
ex. "facebook": "noahwhite"
twitter string The contact's Twitter username.
ex. "twitter": "@noahwhite"
linkedin string The contact's LinkedIn username.
ex. "linkedin": "noahwhite"
tags array The contact's tags. Please note tags cannot contain whitespace. If a tag contains whitespace it will be automatically removed.
ex. "tags": ["whale", "ceo"]
notes string Associated notes.
ex. "notes": "He's our first client."
Curl Example
Response Headers
Response Body
Create an account
Parameters
Name Type Description
type_id integer ID of the contact type. Required For more information see Types
ex. "type_id": 2
is_account boolean Indicator of whether or not this contact is an account or an individual contact. This can only be set during creation of an account.
ex. "is_account": false
name string The account name. Required
"name": "Apple Inc"
address string The contact's address.
ex. "address": "1 Infinite Loop"
address2 string The contact's secondary address.
ex. "address2": "B5"
city string The contact's city.
ex. "city": "Cupertino"
state string The contact's state.
ex. "state": "CA"
postal_code string The contact's postal code.
ex. "postal_code": "95014"
country_id integer The id of the contact's country. See more at Globals.
ex. "country_id": 188
timezone_id integer The id of the contact's timezone. See more at Globals.
ex. "timezone_id": 135
currency_id integer The id of the contact's currency. See more at Globals.
ex. "currency_id": 1
email string The contact's email address.
ex. "email": "sales@apple.com"
phone string The contact's phone number.
ex. "phone": "(408) 996-1010"
mobile string The contact's mobile phone number.
ex. "mobile": "(408) 996-1010"
fax string The contact's fax number.
ex. "fax": "(408) 996-1010"
imessage string The contact's iMessage phone number or email address.
ex. "imessage": ""
facetime string The contact's FaceTime phone number or email address.
ex. "facetime": ""
website string The contact's website address.
ex. "website": "https://www.apple.com"
facebook string The contact's Facebook username.
ex. "facebook": "apple"
twitter string The contact's Twitter username.
ex. "twitter": "@apple"
linkedin string The contact's LinkedIn username.
ex. "linkedin": "apple"
tags array The contact's tags. Please note tags cannot contain whitespace. If a tag contains whitespace it will be automatically removed.
ex. "tags": ["awesome", "mothership"]
notes string Associated notes.
ex. "notes": "My favorite company."
Curl Example
Response Headers
Response Body
Get an individual
Curl Example
Response Headers
Response Body
Get an account
Curl Example
Response Headers
Response Body
Update an individual
Parameters
Name Type Description
type_id integer ID of the contact type. For more information see Types
ex. "type_id": 3
account_id integer The unique id of the associated account.
ex. "account_id": 10000015
first_name string The contact's first name. Individual contacts only.
ex. "first_name": "Noah"
last_name string The contact's last name. Individual contacts only.
ex. "last_name": "Williams"
title string The contact's title. This property will only be set if the contact is an individual.
ex. "title": "EVP Sales"
role string The contact's role. This property will only be set if the contact is an individual.
ex. "role": "Worldwide Sales"
address string The contact's address.
ex. "address": "101 America Street"
address2 string The contact's secondary address.
ex. "address2": "Suite 2601"
city string The contact's city.
ex. "city": "San Francisco"
state string The contact's state.
ex. "state": "CA"
postal_code string The contact's postal code.
ex. "postal_code": "94111"
country_id integer The id of the contact's country. See more at Globals.
ex. "country_id": 188
timezone_id integer The id of the contact's timezone. See more at Globals.
ex. "timezone_id": 134
currency_id integer The id of the contact's currency. See more at Globals.
ex. "currency_id": 1
email string The contact's email address.
ex. "email": "noah@apple.com"
phone string The contact's phone number.
ex. "phone": "(628) 555-1234"
mobile string The contact's mobile phone number.
ex. "mobile": "(628) 555-1235"
fax string The contact's fax number.
ex. "fax": "(628) 555-1236"
imessage string The contact's iMessage phone number or email address.
ex. "imessage": "noah@icloud.com"
facetime string The contact's FaceTime phone number or email address.
ex. "facetime": "noah@icloud.com"
website string The contact's website address.
ex. "website": "https://www.apple.com"
facebook string The contact's Facebook username.
ex. "facebook": "noahwhite"
twitter string The contact's Twitter username.
ex. "twitter": "noahwhite"
linkedin string The contact's LinkedIn username.
ex. "linkedin": "noahwhite"
tags array The contact's tags, this is the whole set of tags that will replace the current tags. Please note tags cannot contain whitespace. If a tag contains whitespace it will be automatically removed.
ex. "tags": ["whale", "sales"]
notes string Associated notes.
ex. "notes": "He's our first client."
Curl Example
Response Headers
Response Body
Update an account
Parameters
Name Type Description
type_id integer ID of the contact type. For more information see Types
ex. "type_id": 6
name string The account name.
ex. "name": "Apple Inc"
address string The contact's address.
ex. "address": "1 Infinite Loop"
address2 string The contact's secondary address.
ex. "address2": "Suite 10"
city string The contact's city.
ex. "city": "Cupertino"
state string The contact's state.
ex. "state": "CA"
postal_code string The contact's postal code.
ex. "postal_code": "95014"
country_id integer The id of the contact's country. See more at Globals.
ex. "country_id": 188
timezone_id integer The id of the contact's timezone. See more at Globals.
ex. "timezone_id": 134
currency_id integer The id of the contact's currency. See more at Globals.
ex. "currency_id": 1
email string The contact's email address.
ex. "email": "sales@apple.com"
phone string The contact's phone number.
ex. "phone": "(408) 996-1010"
mobile string The contact's mobile phone number.
ex. "mobile": "(408) 996-1010"
fax string The contact's fax number.
ex. "fax": "(408) 996-1010"
imessage string The contact's iMessage phone number or email address.
ex. "imessage": "(408) 996-1010"
facetime string The contact's FaceTime phone number or email address.
ex. "facetime": "(408) 996-1010"
website string The contact's website address.
ex. "website": "https://www.apple.com"
facebook string The contact's Facebook username.
ex. "facebook": "apple"
twitter string The contact's Twitter username.
ex. "twitter": "apple"
linkedin string The contact's LinkedIn username.
ex. "linkedin": "apple"
tags array The contact's tags, this is the whole set of tags that will replace the current tags. Please note tags cannot contain whitespace. If a tag contains whitespace it will be automatically removed.
ex. "tags": ["inspirational"]
notes string Associated notes.
ex. "notes": "My favorite company!"
Curl Example
Response Headers
Response Body
Delete a contact
Curl Example
Response Headers
Types
List all types
Curl Example
Response Headers
Response Body
Get a single type
Curl Example
Response Headers
Response Body
Ready to get started

Gro CRM® the Small Business CRM Platform Made Just for Apple Users and Their Devices


Made with in California
© 2019 Gro Software, LLC.
"This is our most-likable website ever"