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.

Deals
  1. Properties
  2. Get all deals
  3. Create a deal
  4. Get a deal
  5. Update a deal
  6. Delete a deal
  7. Sources
  8. Scores
  9. Stages
About the Deals API

The Deals API allows you to fetch all of your deals, create and edit deals, or delete a deal.

Properties
Name Type Description
id integer The id of the deal. Read Only
user_id integer The id of the associated user. For more information on getting a user's id see Users
contact_id integer The id of the associated contact. For more information on getting a contact's id see Contacts
name string Name of the deal.
potential_revenue decimal Potential revenue of the deal.
close_date_start string The beginning of the close date in ISO8601 format. Only used if has_event is true.
close_date string The close date of the deal in ISO8601 format.
stage_id integer The id of the stage. For more information see Stages
score_id integer The id of the score. For more information see Scores
source_id integer The id of the source. For more information see Sources
is_hot boolean Indicates whether the deal is hot.
has_event integer Indicate whether the deal is added to the events calendar.
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
List all deals

List all of your companies 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=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
Create a deal

Create a new deal.

Parameters
Name Type Description
contact_id integer The id of the associated contact. Required
ex. "contact_id": 1000
user_id integer The id of the assigned user. Required
ex. "user_id": 1
name string Name of the deal. Required
ex. "name": "Road resurface"
potential_revenue decimal Potential revenue of the deal.
ex. "potential_revenue": 20000.00
close_date string The close date of the deal in ISO8601 format. Required
ex. "close_date": "2017-06-04T14:00:00Z"
close_date_start string The beginning of the close date in ISO8601 format. Only used if has_event is true.
ex. "close_date_start": "2017-06-04T12:00:00Z"
stage_id integer The id of the stage. Required
ex. "stage_id": 5
score_id integer The id of the score.
ex. "score_id": 10
source_id integer The id of the source.
ex. "source_id": 2
is_hot boolean Indicates whether or not the deal is hot.
ex. "is_hot": true
has_event boolean Indicate whether or not the deal is added to the events calendar.
ex. "has_event": true
notes string Deal notes. "notes": "Payments will be made monthly."
Curl Example
Response Headers
Response Body
Get a deal

Get a single deal using the id. If the deal does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Response Body
Update a deal

Update a deal with the specified id. If the deal does not exist a 404 Not Found status code will be returned.

Parameters
Name Type Description
contact_id integer The id of the associated contact.
ex. "contact_id": 1000
user_id integer The id of the assigned user.
ex. "user_id": 1
name string Name of the deal.
ex. "name": "Road resurface"
potential_revenue decimal Potential revenue of the deal.
ex. "potential_revenue": 20000.00
close_date_start string The beginning of the close date in ISO8601 format. Only used if has_event is true.
ex. "close_date_start": "2017-06-04T12:00:00Z"
close_date string The close date of the deal in ISO8601 format.
ex. "close_date": "2017-06-04T14:00:00Z"
stage_id integer The id of the stage.
ex. "stage_id": 5
score_id integer The id of the score.
ex. "score_id": 10
source_id integer The id of the source.
ex. "source_id": 2
is_hot boolean Indicates whether or not the deal is hot.
ex. "is_hot": true
has_event boolean Indicate whether or not the deal is added to the events calendar.
ex. "has_event": true
notes string Deal notes. "notes": "Payments will be made monthly."
Curl Example
Response Headers
Response Body
Delete a deal

Delete a deal with the specified id. If the deal does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Sources

List all available sources.

List all sources
Curl Example
Response Headers
Response Body
Get a single source

Get a single source with the specified id. If the source does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Response Body
Scores

List all available scores.

List all scores
Curl Example
Response Headers
Response Body
Get a single score

Get a single score with the specified id. If the score does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Response Body
Stages

List all available stages.

List all stages
Curl Example
Response Headers
Response Body
Get a single stage

Get a single stage with the specified id. If the stage does not exist a 404 Not Found status code will be returned.

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"