API

Agents

Listing agents

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

Parameters

Name Type Required Notes
group string no The ID of a Group to filter by

Example response

Status: 200 OK

{
  "agents": [{
    "email": "matt@groovehq.com",
    "first_name": "Matthew",
    "last_name": "Beedle",
    "href": "https://api.groovehq.com/v1/agents/matt@groovehq.com",
    "links": {
      "tickets": {
        "href": "https://api.groovehq.com/v1/tickets?assignee=matt%40groovehq.com"
      }
    }
  }]
}

Finding one agent

GET https://api.groovehq.com/v1/agents/:agent_email

Example Response

Status: 200 OK

{
  "agent": {
    "email": "matt@groovehq.com",
    "first_name": "Matthew",
    "last_name": "Beedle",
    "href": "https://api.groovehq.com/v1/agents/matt@groovehq.com",
    "links": {
      "tickets": {
        "href": "https://api.groovehq.com/v1/tickets?assignee=matt%40groovehq.com"
      }
    }
  }
}