Sign in

v1

latestOpenAPI 3.0.02026-07-24622596.0 KB
Groups

List Groups

get/groups

Query parameters

pageinteger
per_pageinteger

Response

List of groups sorted alphabetically

idstring required

A unique ID for the Group.

company_idstring

A unique ID for the Company the Group belongs to

namestring

The title of the Group

status'active' | 'deleted'

Indicates the status of the Group

group_urlstring

The link to the group in the web app

created_atinteger

Timestamp when the Group was created on the server

updated_atinteger

Timestamp when the Group was last updated

Example response

[
  {
    "id": "3992883",
    "company_id": "8292212",
    "name": "The Psych Crew",
    "users": [
      {
        "id": "2789583992",
        "company_id": "8292212",
        "email_address": "shawn@psych.co",
        "status": "active",
        "first_name": "Shawn",
        "last_name": "Spencer",
        "profile_image": [
          {
            "type": "original",
            "uri": "https://static.companycam.com/VuS0rPvrnNA1490797262.jpg",
            "url": "https://static.companycam.com/VuS0rPvrnNA1490797262.jpg"
          }
        ],
        "phone_number": "4025551212",
        "created_at": 1490737206,
        "updated_at": 1490737206,
        "user_url": "https://app.companycam.com/users/1234"
      }
    ],
    "status": "active",
    "group_url": "https://app.companycam.com/groups/1234",
    "created_at": 1490737206,
    "updated_at": 1490737744
  }
]