Groove

Groove is a customer support helpdesk and shared inbox platform for small and midsize businesses that consolidates email, live chat, social, and knowledge base content into a single agent workspace with automations, collision detection, reporting, and SLAs. Groove also provides customer- facing knowledge bases and self-service portals. Developers can integrate via the v2 GraphQL API or the legacy v1 REST API, both authenticated with an API key obtained from account settings.

3 APIs 0 Features

Customer SupportHelpdeskShared InboxKnowledge BaseConversationsLive Chat

APIs

Groove GraphQL API v2

GraphQL API exposing conversations, messages, agents, contacts, mailboxes, tags, and knowledge base data through a single endpoint. Authentication uses a Bearer API key retrieve...

Groove REST API v1

Legacy REST API for managing customers, conversations, messages, mailboxes, agents, tags, and webhooks in Groove. Authentication uses a Bearer API key. The REST API is no longer...

Groove Webhooks

Groove's webhook surface delivered through the legacy REST API webhook subscription endpoint. Customers register destination URLs and event types via POST /v1/webhooks; Groove t...

Collections

Groove REST API v1

OPEN

GraphQL

Groove GraphQL API

GraphQL API exposing conversations, messages, agents, contacts, mailboxes, tags, and knowledge base data through a single endpoint. Authentication uses a Bearer API key retrieve...

GRAPHQL

Event Specifications

Groove Webhooks

AsyncAPI 2.6 description of Groove's webhook surface as documented for the legacy Groove REST API v1. Groove enables customers to register webhook subscriptions through `POST ht...

ASYNCAPI

Resources

Sources

opencollection: 1.0.0
info:
  name: Groove REST API v1
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: List tickets
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/tickets
  docs: List tickets
- info:
    name: Create a ticket
    type: http
  http:
    method: POST
    url: https://api.groovehq.com/v1/tickets
  docs: Create a ticket
- info:
    name: Find a ticket
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/tickets/:number
    params:
    - name: number
      value: ''
      type: path
  docs: Find a ticket
- info:
    name: Update ticket state
    type: http
  http:
    method: PUT
    url: https://api.groovehq.com/v1/tickets/:number/state
    params:
    - name: number
      value: ''
      type: path
  docs: Update ticket state
- info:
    name: Update ticket assignee
    type: http
  http:
    method: PUT
    url: https://api.groovehq.com/v1/tickets/:number/assignee
    params:
    - name: number
      value: ''
      type: path
  docs: Update ticket assignee
- info:
    name: List messages
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/messages
  docs: List messages
- info:
    name: Create a message
    type: http
  http:
    method: POST
    url: https://api.groovehq.com/v1/messages
  docs: Create a message
- info:
    name: Find a message
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/messages/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Find a message
- info:
    name: List customers
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/customers
  docs: List customers
- info:
    name: Find a customer
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/customers/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Find a customer
- info:
    name: Update a customer
    type: http
  http:
    method: PUT
    url: https://api.groovehq.com/v1/customers/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Update a customer
- info:
    name: List agents
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/agents
  docs: List agents
- info:
    name: Find an agent
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/agents/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Find an agent
- info:
    name: List groups
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/groups
  docs: List groups
- info:
    name: Create a group
    type: http
  http:
    method: POST
    url: https://api.groovehq.com/v1/groups
  docs: Create a group
- info:
    name: Find a group
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/groups/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Find a group
- info:
    name: Update a group
    type: http
  http:
    method: PUT
    url: https://api.groovehq.com/v1/groups/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Update a group
- info:
    name: Delete a group
    type: http
  http:
    method: DELETE
    url: https://api.groovehq.com/v1/groups/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Delete a group
- info:
    name: List mailboxes
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/mailboxes
  docs: List mailboxes
- info:
    name: List folders
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/folders
  docs: List folders
- info:
    name: List attachments
    type: http
  http:
    method: GET
    url: https://api.groovehq.com/v1/attachments
  docs: List attachments
- info:
    name: Upload an attachment
    type: http
  http:
    method: POST
    url: https://api.groovehq.com/v1/attachments
  docs: Upload an attachment
- info:
    name: Create a webhook
    type: http
  http:
    method: POST
    url: https://api.groovehq.com/v1/webhooks
  docs: Create a webhook
- info:
    name: Delete a webhook
    type: http
  http:
    method: DELETE
    url: https://api.groovehq.com/v1/webhooks/:id
    params:
    - name: id
      value: ''
      type: path
  docs: Delete a webhook
bundled: true