The following endpoint is used to connect to the API:
All requests are required to be made over ssl,
http:// is not allowed.
|GET||Used for retrieving resources. The information you request will be returned as JSON.|
|POST||Used for creating new resources. When sending a POST request send all of your required attributes as JSON data.|
|PATCH||Used for updating resources. PATCH requests accept partial JSON data with only the attributes that need to be updated.|
|DELETE||Used for deleting resources.|
The Gro CRM API responds with standard HTTP statuses.
Generally a status code in the 200 range indicates that the request was made successfully and that there were no errors.
Error codes in the 400 range indicates that there was a client errors. Typically these errors are related to a parameter or multiple parameters not being valid formats.
Status codes in the 500 range indicate that there was an error on server side. This is an extremely rare occurrence.
To connect and interact with the Gro CRM API, you must authenticate using an access token. The tokens are sent in the Authorization HTTP header as seen below:
You can generate an access token, by visiting the Gro CRM Account Management system.
When passing parameters for a GET request, parameters should be included using standard HTTP attributes.
When passing parameters for a POST, PATCH, or DELETE request, parameters that are not sent as a query string parameter should be sent as a JSON object. When you are sending data in this format you should set the
Content-Type header to
Responses that contain multiple items are paginated 20 items at a time. You can specify the current page by setting the
page query parameter. If the page parameter is excluded, it will always be defaulted to the first page. You may also pass a
per_page query parameter to indicate how many items are retrieved at once. Default is 20, max is 40.
When pagination is enabled, a links parameter is returned as part of the JSON body. If a request only has one page no links will be returned.
first: The first page's URI.
prev: The previous page's URI.
next: The next page's URI.
last: The last page's URI.
Responses that return multiple items can be sorted by using the
order query parameters.
sort parameter accepts
name. Default is
order parameter accepts
desc. Default is
All requests require a valid
User-Agent header. Requests made with no
User-Agent header will receive a
400 Bad Request error code.
All date/time stamps use industry standard ISO 8601 formatting. By default, timezones use the UTC timezone.
API responses will either return a JSON body or no content.
Errors responses will be returned with a
422 Unprocessable Entity response code.