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.

Users
  1. Properties
  2. Get all users
  3. Get a single user
  4. Get the authenticated user
  5. Roles
About the Users API

The Users API allows you to get your company's current users.

Properties
Name Type Description
id integer The unique id of the user. Read Only
role_id integer The id of the role for the user. For more information see Roles Read Only
has_file_access boolean File access permissions of the user. Only used if the user has a role_id of 3 (User). Read Only
has_inventory_access boolean Inventory access permissions of the user. Only used if the user has a role_id of 3 (User). Read Only
has_purchase_order_access boolean Purchase order access permissions of the user. Only used if the user has a role_id of 3 (User). Read Only
has_invoice_access boolean Invoice access permissions of the user. Only used if the user has a role_id of 3 (User). Read Only
has_payment_access boolean Payment access permissions of the user. Only used if the user has a role_id of 3 (User). Read Only
title string User's title. Read Only
first_name string User's first name. Read Only
last_name string User's last name. Read Only
address string User's address. Read Only
address2 string User's secondary address. Read Only
city string User's city. Read Only
state string User's state. Read Only
postal_code string User's postal code. Read Only
country_id integer The id of the user's country. Read Only
timezone_id integer The id of the user's timezone. Read Only
phone string User's phone number. Read Only
mobile string User's mobile phone number. Read Only
imessage string User's iMessage phone number or email address. Read Only
facetime string User's FaceTime phone number or email address. Read Only
email string User's email address. Read Only
website string User's website address. Read Only
facebook string User's Facebook username. Read Only
twitter string User's Twitter username. Read Only
linkedin string User's LinkedIn username. Read Only
notes string Notes about the user. Read Only
created_at string Date and time that the contact was created. Read Only
updated_at string Date and time that the contact was last updated. Read Only
Get all users

Return all of your company's users.

Curl Example
Response Headers
Response Body
Get a single user

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

Curl Example
Response Headers
Response Body
Get the authenticated user

In addition to returning the existing user properties, you will also be returned the authenticated user's username.

Curl Example
Response Headers
Response Body
Roles
List all roles

List all of the available roles.

Curl Example
Response Headers
Response Body
Get a single role

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