API

Customers

Listing all customers

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

Parameters

Name Type Required Default Notes
page integer No 1 The page number
per_page integer No 25 The number of messages to return per page (max 50)

Example Response

Status: 200 OK

{
  "customers": [
    {
      "href": "https://api.groovehq.com/v1/customers/3217430596",
      "links": {
      "tickets": {
        "href":
          "https://api.groovehq.com/v1/tickets?customer=3217430596"
        }
      },
      "email": "j.smith@gmail.com",
      "name": "John Smith",
      "about": null,
      "twitter_username": null,
      "title": null,
      "company_name": null,
      "phone_number": null,
      "location": null,
      "website_url": null,
      "linkedin_username": null,
      "custom": { }
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 23,
      "total_count": 23,
      "next_page": "http://api.groovehq.dev/v1/customers?page=2"
    }
  }
}

Finding one customer

GET https://api.groovehq.com/v1/customers/:customer_email

Example Response

Status: 200 OK

{
  "customer": {
    "href": "https://api.groovehq.com/v1/customers/3217430596",
    "links": {
      "tickets": {
        "href": "https://api.groovehq.com/v1/tickets?customer=3217430596"
      }
    },
    "email": "j.smith@gmail.com",
    "name": "John Smith",
    "about": null,
    "twitter_username": null,
    "title": null,
    "company_name": null,
    "phone_number": null,
    "location": null,
    "website_url": null,
    "linkedin_username": null,
    "custom": { }
  }
}

Updating a customer

PUT https://api.groovehq.com/v1/customers/:customer_email

Parameters

Name Type Required Notes
email string Yes The customer's email
name string No The customer's full name
about string No Some text about the customer
twitter_username string No The customer's twitter user name
title string No The customer's title
company_name string No The customer's company name
phone_number string No The customer's phone number
location string No The customer's location
linkedin_username string No The customer's linkedin username
custom hash No Any additional customer attributes

Example Response

Status: 200 OK

{
  "customer": {
    "href": "https://api.groovehq.com/v1/customers/3217430596",
     "links": {
      "tickets": {
        "href": "https://api.groovehq.com/v1/tickets?customer=3217430596"
      }
    }
  }
}