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.

Tasks
  1. Properties
  2. Get all tasks
  3. Create a task
  4. Get a task
  5. Update a task
  6. Delete a task
  7. Statuses
  8. Scores
  9. Priorities
About the Tasks API

The Tasks API allows you to fetch all of your tasks, create and edit tasks, or delete a task.

Properties
Name Type Description
id integer The unique id of the task. Read Only
contact_id integer The unique id of the associated account.
user_id integer The unique id of the assigned user.
name string Name of the task.
priority_id integer The id of the priority. For more information see Priorities
score_id integer The id of the score. For more information see Scores
status_id integer The id of the status. For more information see Statuses
due_date_start string The start of the due date in ISO8601 format. Only used if event_calendar is true.
due_date string The due date of the task in ISO8601 format.
is_queued boolean Indicates if the task is added to the follow up queue.
has_event boolean Indicate if the task is added to the event calendar.
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
List all tasks

Returns all tasks that are accessible 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
Create a task

Creates a new task.

Parameters
Name Type Description
contact_id integer ID of the associated contact. Required
ex. "id": 180
user_id integer ID of the associated user. Required
ex. "user_id": 1
name string Task name. Required
ex. "name": "Contact #1 Client"
priority_id integer The id of the task's priority.
ex. "priority_id": 2
status_id integer The id of the task's status.
ex. "status_id": 3
score_id integer The id of the task's score.
ex. "score_id": 5
due_date_start string The start of the due date in ISO8601 format. Only used if has_event is enabled.
ex. "due_date_start": "2017-12-30T16:00:00Z"
due_date string Task's due date in ISO8601 format. Required
ex. "due_date": "2017-12-30T17:00:00Z"
is_queued boolean If the task should be added to the follow up queue.
ex. "is_queued": true
has_event boolean If the task should be added to the event calendar.
ex. "has_event": true
notes strings Additional notes about the task.
ex. "notes": "Remind her about the new products that we released."
Curl Example
Response Headers
Response Body
Get a task

Returns a single task to the user.

Curl Example
Response Headers
Response Body
Update a task

Updates an existing task's information. If the task does not exist a 404 Not Found status code will be returned. The update request can accept partial JSON so you can update only what you need.

Parameters
Name Type Description
contact_id integer ID of the associated contact.
ex. "id": 180
user_id integer ID of the associated user.
ex. "user_id": 1
name string Task name.
ex. "name": "Contact #1 Client"
priority_id integer The id of the task's priority.
ex. "priority_id": 2
status_id integer The id of the task's status.
ex. "status_id": 3
score_id integer The id of the task's score.
ex. "score_id": 5
due_date_start string The start of the due date in ISO8601 format. Only used if has_event is enabled.
ex. "due_date_start": "2017-12-30T16:00:00Z"
due_date string Task's due date in ISO8601 format.
ex. "due_date": "2017-12-30T17:00:00Z"
notes strings Additional notes about the task.
ex. "notes": "Remind her about the new products that we released."
Curl Example
Response Headers
Response Body
Delete a task

Deletes the specified existing task. If the task does not exist a 404 Not Found status code will be returned.

Curl Example
Response Headers
Statuses
List all statuses

List all of the available task statuses

Curl Example
Response Headers
Response Body
Get a single status

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

Curl Example
Response Headers
Response Body
Scores
List all scores

List all of the available task 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
Priorities
List all priorities

List all of the available task priorities

Curl Example
Response Headers
Response Body
Get a single priority

Get a single priority with the specified id. If the priority 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"