Groups

Listing groups

GET https://api.groovehq.com/v1/groups

Example Response

Status: 200 OK

{
  "groups": [{
    "id": "1234442341",
    "name": "Founders",
    "links": {
      "agents": {
        "href": "http://api.groovehq.com/v1/agents?group=1234442341"
      }
    }
  }]
}

Finding one group

GET https://api.groovehq.com/v1/groups/:id

Example Response

Status: 200 OK
Location: https://api.groovehq.com/v1/groups/4517239960

{
  "group": {
    "id": "4517239960",
    "name": "Support",
    "description": "Support Team",
    "links": {
      "agents": {
        "href": "https://api.groovehq.com/v1/agents?group=4517239960"
      }
    },
    "agent_ids": [
      "3328848992",
      "5928492716",
    ]
  }
}

Creating a new group

POST https://api.groovehq.com/v1/groups

Name	Type	Required	Notes
name	string	Yes	The name of the group
description	string	No	A short description of the group
agents	array	No	Array of agent emails or ids to assign to the group

Example Response

Status: 201 Created
Location: https://api.groovehq.com/v1/groups

{
  "group": {
    "id": "4517239960",
    "name": "Support",
    "description": "Support Team",
    "links": {
      "agents": {
        "href": "https://api.groovehq.com/v1/agents?group=4517239960"
      }
    },
    "agent_ids": [
      "3328848992",
      "5928492716",
    ]
  }
}

Updating a group

PUT https://api.groovehq.com/v1/groups/:group_id

Name	Type	Required	Notes
name	string	No	The name of the group
description	string	No	A short description of the group
agents	array	No	Array of agent emails or ids that are members of the group

Example Response

Status: 200 OK
Location: https://api.groovehq.com/v1/groups/4517239960

{
  "group": {
    "id": "4517239960",
    "name": "Support",
    "description": "Awesome Support Team",
    "links": {
      "agents": {
        "href": "https://api.groovehq.com/v1/agents?group=4517239960"
      }
    },
    "agent_ids": [
      "3328848992",
      "5928492716",
    ]
  }
}

Deleting a group

DELETE https://api.groovehq.com/v1/groups/:id

Example Response

Status: 200 OK
Location: https://api.groovehq.com/v1/groups/4517239960

{
  "group": {
    "id": "4517239960",
    "name": "Support",
    "description": "Support Team",
    "links": {
      "agents": {
        "href": "https://api.groovehq.com/v1/agents?group=4517239960"
      }
    },
    "agent_ids": [
      "3328848992",
      "5928492716",
    ]
  }
}