Hint Health API

Hint API Developer Hub

HintOS integrations is our answer to healthcare’s longstanding dependence on insufficient all-in-one systems. It is ‘best-of-breed” technology that allows provider organizations to instantly snap together a dream team of industry-leading applications. The result? Complete, fully integrated solutions that function seamlessly together.

We invite you to become a part this ecosystem of integration solutions.

Guides
Suggest Edits

GlobalWebhookEndpoint

 
Suggest Edits

List All Webhook Endpoints

 
gethttps://api.staging.hint.com/api/global_webhook_endpoints
curl --request GET \
  --url https://api.staging.hint.com/api/global_webhook_endpoints
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/global_webhook_endpoints' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/global_webhook_endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/global_webhook_endpoints");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/global_webhook_endpoints"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  },
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  },
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  }
]

Response

Successful response

Suggest Edits

Create Webhook Endpoint

 
posthttps://api.staging.hint.com/api/global_webhook_endpoints
curl --request POST \
  --url https://api.staging.hint.com/api/global_webhook_endpoints
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/global_webhook_endpoints' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/global_webhook_endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/global_webhook_endpoints");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/global_webhook_endpoints"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Body Params

webhook_url
string
required

Response

Successful response

Suggest Edits

Show Webhook Endpoint

 
gethttps://api.staging.hint.com/api/global_webhook_endpoints/id
curl --request GET \
  --url https://api.staging.hint.com/api/global_webhook_endpoints/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/global_webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/global_webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/global_webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/global_webhook_endpoints/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Path Params

id
string
required

Unique Global Webhook Endpoint ID

Response

Successful response

Suggest Edits

Update Webhook Endpoint

 
patchhttps://api.staging.hint.com/api/global_webhook_endpoints/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/global_webhook_endpoints/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/global_webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/global_webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/global_webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/global_webhook_endpoints/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Path Params

id
string
required

Unique Global Webhook Endpoint ID

Body Params

webhook_url
string

Response

Successful response

Suggest Edits

Delete Webhook Endpoint

 
deletehttps://api.staging.hint.com/api/global_webhook_endpoints/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/global_webhook_endpoints/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/global_webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/global_webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/global_webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/global_webhook_endpoints/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Global Webhook Endpoint ID

Response

No content

Suggest Edits

Integration

 
Suggest Edits

List All Integrations

 
gethttps://api.staging.hint.com/api/integrations
curl --request GET \
  --url https://api.staging.hint.com/api/integrations
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/integrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/integrations");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "int-ab12C345DeF6",
    "expires_in": null,
    "refresh_token": null,
    "status": "requested",
    "token_type": "bearer",
    "webhook_url_default": "https://hint-partner-emr.com/webhooks/hint",
    "webhook_url_override": "https://integration.example.hint.com",
    "practice": {
      "id": "pra-ab12C345DeF6",
      "name": "Dr. Phil"
    }
  }
]

Response

Successful response

Suggest Edits

Show Integration

 
gethttps://api.staging.hint.com/api/integrations/id
curl --request GET \
  --url https://api.staging.hint.com/api/integrations/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/integrations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/integrations/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "int-ab12C345DeF6",
  "expires_in": null,
  "refresh_token": null,
  "status": "requested",
  "token_type": "bearer",
  "webhook_url_default": "https://hint-partner-emr.com/webhooks/hint",
  "webhook_url_override": "https://integration.example.hint.com",
  "practice": {
    "id": "pra-ab12C345DeF6",
    "name": "Dr. Phil"
  }
}

Path Params

id
string
required

Unique Integration ID

Response

Successful response

Suggest Edits

Update Integration

 
patchhttps://api.staging.hint.com/api/integrations/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/integrations/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/integrations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/integrations/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "int-ab12C345DeF6",
  "expires_in": null,
  "refresh_token": null,
  "status": "requested",
  "token_type": "bearer",
  "webhook_url_default": "https://hint-partner-emr.com/webhooks/hint",
  "webhook_url_override": "https://integration.example.hint.com",
  "practice": {
    "id": "pra-ab12C345DeF6",
    "name": "Dr. Phil"
  }
}

Path Params

id
string
required

Unique Integration ID

Body Params

webhook_url_override
string

Response

Successful response

Suggest Edits

Deactivate Integration

 
posthttps://api.staging.hint.com/api/integrations/id/deactivate
curl --request POST \
  --url https://api.staging.hint.com/api/integrations/id/deactivate
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/integrations/id/deactivate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/id/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/integrations/id/deactivate");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/id/deactivate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "int-ab12C345DeF6",
  "expires_in": null,
  "refresh_token": null,
  "status": "inactive",
  "token_type": "bearer",
  "webhook_url_default": "https://hint-partner-emr.com/webhooks/hint",
  "webhook_url_override": "https://integration.example.hint.com",
  "practice": {
    "id": "pra-ab12C345DeF6",
    "name": "Dr. Phil"
  }
}

Path Params

id
string
required

Unique Integration ID

Response

Successful response

Suggest Edits

WebhookEndpoint

 
Suggest Edits

List All Webhook Endpoints

 
gethttps://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints
curl --request GET \
  --url https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  },
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  },
  {
    "id": "whep-ab12C345DeF6",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "webhook_url": "https://api.partner/webhook_endpoint_url"
  }
]

Path Params

integration_id
string
required

Unique Integration ID

Response

Successful response

Suggest Edits

Create Webhook Endpoint

 
posthttps://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints
curl --request POST \
  --url https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Path Params

integration_id
string
required

Unique Integration ID

Body Params

webhook_url
string
required

Response

Successful response

Suggest Edits

Show Webhook Endpoint

 
gethttps://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
curl --request GET \
  --url https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Path Params

integration_id
string
required

Unique Integration ID

id
string
required

Unique Webhook Endpoint ID

Response

Successful response

Suggest Edits

Update Webhook Endpoint

 
patchhttps://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "whep-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "webhook_url": "https://api.partner/webhook_endpoint_url"
}

Path Params

integration_id
string
required

Unique Integration ID

id
string
required

Unique Webhook Endpoint ID

Body Params

webhook_url
string

Response

Successful response

Suggest Edits

Delete Webhook Endpoint

 
deletehttps://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/integrations/integration_id/webhook_endpoints/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

integration_id
string
required

Unique Integration ID

id
string
required

Unique Webhook Endpoint ID

Response

No content

Suggest Edits

Exchange Code for Access Token

 
posthttps://api.staging.hint.com/api/oauth/tokens
curl --request POST \
  --url https://api.staging.hint.com/api/oauth/tokens
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/oauth/tokens' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/oauth/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/oauth/tokens");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/oauth/tokens"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "int-ab12C345DeF6",
  "expires_in": null,
  "refresh_token": null,
  "status": "active",
  "token_type": "bearer",
  "webhook_url_default": "https://hint-partner-emr.com/webhooks/hint",
  "webhook_url_override": "https://integration.example.hint.com",
  "practice": {
    "id": "pra-ab12C345DeF6",
    "name": "Dr. Phil"
  },
  "access_token": "i22X3eTjsV9kfNapfpuKYPrFU0hINpK9tVG3"
}

Body Params

grant_type
string
required
code
string
required

Response

Successful response

 
Suggest Edits

Show Partner

 
gethttps://api.staging.hint.com/api/partner
curl --request GET \
  --url https://api.staging.hint.com/api/partner
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/partner' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/partner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/partner");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/partner"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "ptr-ab12C345DeF6",
  "email": "jane.doe@hint-partner-emr.com",
  "integration_description": "Two-way data sync with a Hint API Partner",
  "logo_url": null,
  "marketing_url": "https://api.hint-partner-emr.com",
  "name": "Hint-Partner EMR",
  "product_description": "Hint-Partner EMR",
  "redirect_url": "https://hint-partner-emr.com/login?from=hint",
  "support_url": "https://hint-partner-emr.com/support",
  "webhook_url": "https://hint-partner-emr.com/webhooks/hint",
  "webhooks_disabled": false
}

Response

Successful response

Suggest Edits

Update Partner

 
patchhttps://api.staging.hint.com/api/partner
curl --request PATCH \
  --url https://api.staging.hint.com/api/partner
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.staging.hint.com/api/partner' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/partner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/partner");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/partner"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "ptr-ab12C345DeF6",
  "email": "jane.doe@hint-partner-emr.com",
  "integration_description": "Two-way data sync with a Hint API Partner",
  "logo_url": null,
  "marketing_url": "https://api.hint-partner-emr.com",
  "name": "Hint-Partner EMR",
  "product_description": "Hint-Partner EMR",
  "redirect_url": "https://hint-partner-emr.com/login?from=hint",
  "support_url": "https://hint-partner-emr.com/support",
  "webhook_url": "https://hint-partner-emr.com/webhooks/hint",
  "webhooks_disabled": false
}

Body Params

webhook_url
string
marketing_url
string
support_url
string
redirect_url
string
product_description
string
integration_description
string
email
string
logo_url
https_url

Response

Successful response

Suggest Edits

ChargeItem

 
Suggest Edits

List All Charge Items

 
gethttps://api.staging.hint.com/api/provider/charge_items
curl --request GET \
  --url https://api.staging.hint.com/api/provider/charge_items
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/charge_items' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/charge_items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/charge_items");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/charge_items"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "item-ab12C345DeF6",
    "name": "HbA1c #2",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "description": "Diagnostic lab test for Hemaglobin A1C",
    "price_in_cents": 500,
    "provider_web_link": "https://app.hint.com/admin/charge_items/item-ab12C345DeF6"
  }
]

Response

Successful response

Suggest Edits

Create Charge Item

 
posthttps://api.staging.hint.com/api/provider/charge_items
curl --request POST \
  --url https://api.staging.hint.com/api/provider/charge_items
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/provider/charge_items' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/charge_items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/charge_items");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/charge_items"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "item-ab12C345DeF6",
  "name": "HbA1c #3",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "description": "Diagnostic lab test for Hemaglobin A1C",
  "price_in_cents": 500,
  "provider_web_link": "https://app.hint.com/admin/charge_items/item-ab12C345DeF6"
}

Body Params

name
string
required
price_in_cents
double
required
type
string
required
description
string

Response

Successful response

Suggest Edits

Show Charge Item

 
gethttps://api.staging.hint.com/api/provider/charge_items/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/charge_items/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/charge_items/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/charge_items/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/charge_items/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/charge_items/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "item-ab12C345DeF6",
  "name": "HbA1c #3",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "description": "Diagnostic lab test for Hemaglobin A1C",
  "price_in_cents": 500,
  "provider_web_link": "https://app.hint.com/admin/charge_items/item-ab12C345DeF6"
}

Path Params

id
string
required

Unique Charge Item ID

Response

Successful response

Suggest Edits

Update Charge Item

 
patchhttps://api.staging.hint.com/api/provider/charge_items/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/charge_items/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/charge_items/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/charge_items/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/charge_items/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/charge_items/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "item-ab12C345DeF6",
  "name": "HbA1c #3",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "description": "Diagnostic lab test for Hemaglobin A1C",
  "price_in_cents": 500,
  "provider_web_link": "https://app.hint.com/admin/charge_items/item-ab12C345DeF6"
}

Path Params

id
string
required

Unique Charge Item ID

Body Params

name
string
required
price_in_cents
double
required
type
string
required
description
string

Response

Successful response

Suggest Edits

Delete Charge Item

 
deletehttps://api.staging.hint.com/api/provider/charge_items/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/charge_items/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/charge_items/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/charge_items/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/charge_items/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/charge_items/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Charge Item ID

Response

No content

 
Suggest Edits

List All Companies

 
gethttps://api.staging.hint.com/api/provider/companies
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/companies' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "com-ab12C345DeF6",
    "name": "Schmoogle Inc.",
    "address": {
      "id": "add-ab12C345DeF6",
      "city": "New York",
      "country": "United States",
      "latitude": 40.7227998,
      "line1": "157 E Houston St",
      "line2": "Suite 2402",
      "longitude": -73.9892241,
      "state": "NY",
      "zip": "10002"
    },
    "phones": [
      {
        "type": "Mobile",
        "number": "5553050003"
      }
    ],
    "employee_divisions_count": 0
  }
]

Response

Successful response

Suggest Edits

Show Company

 
gethttps://api.staging.hint.com/api/provider/companies/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "com-ab12C345DeF6",
  "name": "Schmoogle Inc.",
  "address": {
    "id": "add-ab12C345DeF6",
    "city": "New York",
    "country": "United States",
    "latitude": 40.7227998,
    "line1": "157 E Houston St",
    "line2": "Suite 2402",
    "longitude": -73.9892241,
    "state": "NY",
    "zip": "10002"
  },
  "phones": [
    {
      "type": "Mobile",
      "number": "5553050004"
    }
  ],
  "employee_divisions_count": 0
}

Path Params

id
string
required

Unique Company ID

Response

Successful response

Suggest Edits

EmployeeDivision

 
Suggest Edits

List All Employee Divisions

 
gethttps://api.staging.hint.com/api/provider/companies/company_id/employee_divisions
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/company_id/employee_divisions
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/employee_divisions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/employee_divisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/company_id/employee_divisions");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/employee_divisions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "div-ab12C345DeF6",
    "name": "Accounting"
  }
]

Path Params

company_id
string
required

Unique Company ID

Response

Successful response

 
Suggest Edits

List All Invoices

 
gethttps://api.staging.hint.com/api/provider/companies/company_id/invoices
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/company_id/invoices
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/invoices' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/company_id/invoices");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/invoices"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "inv-ab12C345DeF6",
    "invoice_number": 1,
    "invoice_date": "2017-02-01",
    "amount_in_cents": 20000,
    "human_status": "issued",
    "paid_in_cents": 0,
    "paid_at": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Isaac Supplies Inc",
      "owner": {
        "id": "user-ab12C345DeF6",
        "email": "joe_136@example.com",
        "first_name": "Joe",
        "last_name": "Blogs",
        "name": "Joe Blogs"
      }
    }
  }
]

Path Params

company_id
string
required

Unique Company ID

Response

Successful response

Suggest Edits

Show Invoice

 
gethttps://api.staging.hint.com/api/provider/companies/company_id/invoices/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/company_id/invoices/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/invoices/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/invoices/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/company_id/invoices/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/invoices/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "invoice_number": 1,
  "invoice_date": "2017-02-01",
  "amount_in_cents": 20000,
  "human_status": "issued",
  "paid_in_cents": 0,
  "paid_at": null,
  "company": {
    "id": "com-ab12C345DeF6",
    "name": "Isaac Supplies Inc",
    "owner": {
      "id": "user-ab12C345DeF6",
      "email": "joe_137@example.com",
      "first_name": "Joe",
      "last_name": "Blogs",
      "name": "Joe Blogs"
    }
  }
}

Path Params

company_id
string
required

Unique Company ID

id
string
required

Unique Invoice ID

Response

Successful response

Suggest Edits

InvoicePayment

 
Suggest Edits

List All Payments

 
gethttps://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "pmt-ab12C345DeF6",
    "error_message": null,
    "memo": null,
    "status": "unattempted",
    "date": "2017-02-05T06:23:00-08:00",
    "amount_in_cents": 4999,
    "source": {
      "id": "card-ab12C345DeF6",
      "type": "Card"
    }
  }
]

Path Params

company_id
string
required

Unique Company ID

invoice_id
string
required

Unique Invoice ID

Response

Successful response

Suggest Edits

Create Payment

 
posthttps://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments
curl --request POST \
  --url https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "pmt-ab12C345DeF6",
  "error_message": null,
  "memo": null,
  "status": "unattempted",
  "date": "2017-02-05T06:23:00-08:00",
  "amount_in_cents": 4999,
  "source": {
    "id": "card-ab12C345DeF6",
    "type": "Card"
  }
}

Path Params

company_id
string
required

Unique Company ID

invoice_id
string
required

Unique Invoice ID

Body Params

amount_in_cents
double

When creating a payment you can add an amount_in_cents, if no amount is included, we will set the payment amount = due_in_cents.

external
boolean

When creating a payment, stripe payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

memo
string
process
boolean

When creating a payment, stripe payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

paid_at
date

When creating a payment you can specify the date, if no a date is included, we will set it to the practice.today date.

source
object
 
source.id
string
required
source.type
string
required

Response

Successful response

Suggest Edits

Show Payment

 
gethttps://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/companies/company_id/invoices/invoice_id/payments/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "pmt-ab12C345DeF6",
  "error_message": null,
  "memo": null,
  "status": "unattempted",
  "date": "2017-02-05T06:23:00-08:00",
  "amount_in_cents": 4999,
  "source": {
    "id": "card-ab12C345DeF6",
    "type": "Card"
  }
}

Path Params

company_id
string
required

Unique Company ID

invoice_id
string
required

Unique Invoice ID

id
string
required

Unique Invoice Payment ID

Response

Successful response

Suggest Edits

CustomerInvoice

 
Suggest Edits

List All Customer Invoices

 
gethttps://api.staging.hint.com/api/provider/customer_invoices
curl --request GET \
  --url https://api.staging.hint.com/api/provider/customer_invoices
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/customer_invoices");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "inv-ab12C345DeF6",
    "status": "draft",
    "human_status": "draft",
    "date": "2017-02-05",
    "subtotal_in_cents": 4999,
    "tax_in_cents": 0,
    "total_in_cents": 4999,
    "paid_at": null,
    "due_in_cents": 4999,
    "sponsor_amount_in_cents": null,
    "sponsor_name": null,
    "sponsor_invoice_status": null,
    "paid_in_cents": 0,
    "last_sent_at": null,
    "last_viewed_at": null,
    "invoice_number": 1,
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "received_in_cents": 0,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
    "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
    "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
    "payment_status": null,
    "integration_record_id": "ABCD001206",
    "amount_in_cents": 4999,
    "owner": {
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "health_insurance_group_id": "12345",
      "health_insurance_member_id": "A22222222",
      "health_insurance_payer_id": "00039",
      "health_insurance_payer_name": "Anthem Blue Cross California",
      "lead_source_other": "Downtown marketing event",
      "membership_status": "active",
      "uses_tobacco": false,
      "id": "pat-ab12C345DeF6",
      "age": 65,
      "created_at": "2017-02-05T06:23:00-08:00",
      "dob": "1952-01-01",
      "electronic_communication_consent_accepted": true,
      "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
      "email": "bass_man@bumble_bee_inc.com",
      "external_link_id": null,
      "first_name": "Gordon",
      "gender": "male",
      "hipaa_authorization_accepted": true,
      "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
      "import_id": null,
      "import_source": null,
      "joined_practice_date": "2017-02-05",
      "last_name": "Sumner",
      "middle_name": "Thomas",
      "name": "Gordon Thomas Sumner",
      "patient_agreement_accepted": false,
      "patient_agreement_accepted_at": null,
      "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
      "terms_accepted": false,
      "terms_accepted_at": null,
      "updated_at": "2017-02-05T06:23:00-08:00",
      "lead_source": {
        "id": "lds-ab12C345DeF6",
        "name": "Other",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00"
      },
      "phones": [],
      "integration_sync_status": null,
      "integration_error_message": null,
      "integration_web_link": null,
      "integration_last_synced_at": null,
      "integration_record_id": null,
      "company": {
        "id": "com-ab12C345DeF6",
        "name": "Schmoogle Inc."
      },
      "practitioner": null,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      },
      "practitioner_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      },
      "location": {
        "id": "loc-ab12C345DeF6",
        "address_city": "New York",
        "address_country": "United States",
        "address_line1": "157 E Houston St",
        "address_line2": "Suite 2402",
        "address_state": "NY",
        "address_zip": "10002",
        "name": "San Francisco HQ",
        "phone_number": null,
        "virtual": false,
        "location_group": {
          "id": "prg-ab12C345DeF6",
          "name": "Downtown Location Group",
          "created_at": "2017-02-05T06:23:00-08:00",
          "updated_at": "2017-02-05T06:23:00-08:00",
          "integration_record_id": null
        }
      },
      "memberships": [],
      "account": {
        "name": "Gordon Thomas Sumner",
        "past_due_in_cents": 0
      },
      "external_records": [],
      "ssn": {
        "masked_number": "***-**-1234"
      }
    },
    "charges_count": 1,
    "payments_count": 0
  }
]

Query Params

updated_at
date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

created_at
date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

Response

Successful response

Suggest Edits

Create Customer Invoice

 
posthttps://api.staging.hint.com/api/provider/customer_invoices
curl --request POST \
  --url https://api.staging.hint.com/api/provider/customer_invoices
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/customer_invoices");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "status": "draft",
  "human_status": "draft",
  "date": "2017-02-05",
  "subtotal_in_cents": 4999,
  "tax_in_cents": 0,
  "total_in_cents": 4999,
  "paid_at": null,
  "due_in_cents": 4999,
  "sponsor_amount_in_cents": null,
  "sponsor_name": null,
  "sponsor_invoice_status": null,
  "paid_in_cents": 0,
  "last_sent_at": null,
  "last_viewed_at": null,
  "invoice_number": 1,
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "received_in_cents": 0,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
  "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "payment_status": null,
  "integration_record_id": "ABCD001209",
  "amount_in_cents": 4999,
  "owner": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charges_count": 1,
  "payments_count": 0
}

Body Params

integration_record_id
string
owner
object
 
owner.id
string
required
patient
object
 
patient.id
string
required

Response

Successful response

Suggest Edits

Show Customer Invoice

Status Options: draft, issued, sent, cancelled, retrying, bad_debt, paid, disputed
Human Status Options: draft, issued, sent, cancelled, bank_not_verified, needs_payment_info, retrying, bad_debt, paid, disputed

 
gethttps://api.staging.hint.com/api/provider/customer_invoices/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/customer_invoices/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/customer_invoices/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "status": "draft",
  "human_status": "draft",
  "date": "2017-02-05",
  "subtotal_in_cents": 4999,
  "tax_in_cents": 0,
  "total_in_cents": 4999,
  "paid_at": null,
  "due_in_cents": 4999,
  "sponsor_amount_in_cents": null,
  "sponsor_name": null,
  "sponsor_invoice_status": null,
  "paid_in_cents": 0,
  "last_sent_at": null,
  "last_viewed_at": null,
  "invoice_number": 1,
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "received_in_cents": 0,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
  "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "payment_status": null,
  "integration_record_id": "ABCD001209",
  "amount_in_cents": 4999,
  "owner": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charges_count": 1,
  "payments_count": 0
}

Path Params

id
string
required

Unique Customer Invoice ID

Response

Successful response

Suggest Edits

Update Customer Invoice

 
patchhttps://api.staging.hint.com/api/provider/customer_invoices/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/customer_invoices/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/customer_invoices/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "status": "draft",
  "human_status": "draft",
  "date": "2017-02-05",
  "subtotal_in_cents": 4999,
  "tax_in_cents": 0,
  "total_in_cents": 4999,
  "paid_at": null,
  "due_in_cents": 4999,
  "sponsor_amount_in_cents": null,
  "sponsor_name": null,
  "sponsor_invoice_status": null,
  "paid_in_cents": 0,
  "last_sent_at": null,
  "last_viewed_at": null,
  "invoice_number": 1,
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "received_in_cents": 0,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
  "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "payment_status": null,
  "integration_record_id": "ABCD001209",
  "amount_in_cents": 4999,
  "owner": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charges_count": 1,
  "payments_count": 0
}

Path Params

id
string
required

Unique Customer Invoice ID

Body Params

integration_record_id
string
owner
object
 
owner.id
string
required
patient
object
 
patient.id
string
required

Response

Successful response

Suggest Edits

Delete Customer Invoice

 
deletehttps://api.staging.hint.com/api/provider/customer_invoices/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/customer_invoices/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/customer_invoices/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Customer Invoice ID

Response

No content

Suggest Edits

Issue Customer Invoice

 
posthttps://api.staging.hint.com/api/provider/customer_invoices/id/issue
curl --request POST \
  --url https://api.staging.hint.com/api/provider/customer_invoices/id/issue
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/id/issue' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/id/issue")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/customer_invoices/id/issue");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/id/issue"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "status": "issued",
  "human_status": "needs_payment_info",
  "date": "2017-02-05",
  "subtotal_in_cents": 4999,
  "tax_in_cents": 0,
  "total_in_cents": 4999,
  "paid_at": null,
  "due_in_cents": 4999,
  "sponsor_amount_in_cents": null,
  "sponsor_name": null,
  "sponsor_invoice_status": null,
  "paid_in_cents": 0,
  "last_sent_at": null,
  "last_viewed_at": null,
  "invoice_number": 1,
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "received_in_cents": 0,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
  "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "payment_status": null,
  "integration_record_id": "ABCD0012012",
  "amount_in_cents": 4999,
  "owner": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 4999
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charges_count": 1,
  "payments_count": 0
}

Path Params

id
string
required

Unique Customer Invoice ID

Response

Successful response

Suggest Edits

Void Customer Invoice

 
posthttps://api.staging.hint.com/api/provider/customer_invoices/id/void
curl --request POST \
  --url https://api.staging.hint.com/api/provider/customer_invoices/id/void
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/id/void' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/id/void")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/customer_invoices/id/void");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/id/void"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "inv-ab12C345DeF6",
  "status": "cancelled",
  "human_status": "cancelled",
  "date": "2017-02-05",
  "subtotal_in_cents": 4999,
  "tax_in_cents": 0,
  "total_in_cents": 4999,
  "paid_at": null,
  "due_in_cents": 4999,
  "sponsor_amount_in_cents": null,
  "sponsor_name": null,
  "sponsor_invoice_status": null,
  "paid_in_cents": 0,
  "last_sent_at": null,
  "last_viewed_at": null,
  "invoice_number": 1,
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00",
  "received_in_cents": 0,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6",
  "secure_pdf_printable_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "secure_pdf_inline_url": "https://api.hint.com/api/files/0jlsWoWWS2M6",
  "payment_status": null,
  "integration_record_id": "ABCD0012015",
  "amount_in_cents": 4999,
  "owner": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charges_count": 1,
  "payments_count": 0
}

Path Params

id
string
required

Unique Customer Invoice ID

Response

Successful response

Suggest Edits

Create Charge

 
posthttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges
curl --request POST \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "is_persisted": true,
  "id": "cha-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "description": null,
  "name": "Lab fee",
  "price_in_cents": 1000,
  "quantity": 1,
  "service_date": "2017-02-05",
  "status": "draft",
  "subtotal_in_cents": 1000,
  "tax_in_cents": 0,
  "total_in_cents": 1000,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "patient": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "i_heart_rufus@chaka.com",
    "external_link_id": null,
    "first_name": "Yvette",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Stevens",
    "middle_name": "Thomas",
    "name": "Yvette Thomas Stevens",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Yvette Thomas Stevens",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charge_item": null,
  "practitioner": null,
  "category": null,
  "amount_in_cents": 1000
}

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

Body Params

quantity
double
required
price_in_cents
double
required
name
string
required
description
string
date
date
patient
object
 
patient.id
string
required
practitioner
object
 
practitioner.id
string
required
category
object
 
category.id
string
required
charge_item
object
 
charge_item.id
string
required

Response

Successful response

Suggest Edits

New Charge: Returns an unsaved default charge on the given customer invoice

 
gethttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new
curl --request GET \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/new"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "is_persisted": true,
  "id": "cha-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "description": null,
  "name": "Lab fee",
  "price_in_cents": 1000,
  "quantity": 1,
  "service_date": "2017-02-05",
  "status": "draft",
  "subtotal_in_cents": 1000,
  "tax_in_cents": 0,
  "total_in_cents": 1000,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "patient": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "i_heart_rufus@chaka.com",
    "external_link_id": null,
    "first_name": "Yvette",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Stevens",
    "middle_name": "Thomas",
    "name": "Yvette Thomas Stevens",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Yvette Thomas Stevens",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charge_item": null,
  "practitioner": null,
  "category": null,
  "amount_in_cents": 1000
}

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

Response

Successful response

Suggest Edits

Update Charge

 
patchhttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "is_persisted": true,
  "id": "cha-ab12C345DeF6",
  "created_at": "2017-02-05T06:23:00-08:00",
  "description": null,
  "name": "Lab fee",
  "price_in_cents": 1000,
  "quantity": 1,
  "service_date": "2017-02-05",
  "status": "draft",
  "subtotal_in_cents": 1000,
  "tax_in_cents": 0,
  "total_in_cents": 1000,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "patient": {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "i_heart_rufus@chaka.com",
    "external_link_id": null,
    "first_name": "Yvette",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Stevens",
    "middle_name": "Thomas",
    "name": "Yvette Thomas Stevens",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Yvette Thomas Stevens",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  },
  "charge_item": null,
  "practitioner": null,
  "category": null,
  "amount_in_cents": 1000
}

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

id
string
required

Unique Charge ID

Body Params

quantity
double
required
price_in_cents
double
required
name
string
required
description
string
date
date
patient
object
 
patient.id
string
required
practitioner
object
 
practitioner.id
string
required
category
object
 
category.id
string
required
charge_item
object
 
charge_item.id
string
required

Response

Successful response

Suggest Edits

Delete Charge

 
deletehttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/charges/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

id
string
required

Unique Charge ID

Response

No content

Suggest Edits

CustomerInvoicePayment

 
Suggest Edits

List All Payments

 
gethttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments
curl --request GET \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "pmt-ab12C345DeF6",
    "error_message": null,
    "memo": null,
    "status": "unattempted",
    "date": "2017-02-05T06:23:00-08:00",
    "amount_in_cents": 4999,
    "source": {
      "id": "card-ab12C345DeF6",
      "type": "Card"
    }
  }
]

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

Response

Successful response

Suggest Edits

Create Payment

 
posthttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments
curl --request POST \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "pmt-ab12C345DeF6",
  "error_message": null,
  "memo": null,
  "status": "unattempted",
  "date": "2017-02-05T06:23:00-08:00",
  "amount_in_cents": 4999,
  "source": {
    "id": "card-ab12C345DeF6",
    "type": "Card"
  }
}

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

Body Params

amount_in_cents
double

When creating a payment you can add an amount_in_cents, if no amount is included, we will set the payment amount = due_in_cents.

external
boolean

When creating a payment, stripe payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

memo
string
process
boolean

When creating a payment, stripe payments are required to include process: true, mark-as-paid payments are required to include external: true as an attribute. The request fails if it does not contain only one of these attributes.

paid_at
date

When creating a payment you can specify the date, if no a date is included, we will set it to the practice.today date.

source
object
 
source.id
string
required
source.type
string
required

Response

Successful response

Suggest Edits

Show Payment

 
gethttps://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/customer_invoices/customer_invoice_id/payments/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "pmt-ab12C345DeF6",
  "error_message": null,
  "memo": null,
  "status": "unattempted",
  "date": "2017-02-05T06:23:00-08:00",
  "amount_in_cents": 4999,
  "source": {
    "id": "card-ab12C345DeF6",
    "type": "Card"
  }
}

Path Params

customer_invoice_id
string
required

Unique Customer Invoice ID

id
string
required

Unique Customer Invoice Payment ID

Response

Successful response

Suggest Edits

LeadSource

 
Suggest Edits

List All Lead Sources

 
gethttps://api.staging.hint.com/api/provider/lead_sources
curl --request GET \
  --url https://api.staging.hint.com/api/provider/lead_sources
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/lead_sources' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/lead_sources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/lead_sources");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/lead_sources"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "lds-ab12C345DeF6",
    "name": "Online Ad1",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00"
  }
]

Response

Successful response

Suggest Edits

Create LeadSource

 
posthttps://api.staging.hint.com/api/provider/lead_sources
curl --request POST \
  --url https://api.staging.hint.com/api/provider/lead_sources
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/provider/lead_sources' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/lead_sources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/lead_sources");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/lead_sources"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "lds-ab12C345DeF6",
  "name": "Online Ad2",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00"
}

Body Params

name
string

Response

Successful response

Suggest Edits

Update Lead Source

 
patchhttps://api.staging.hint.com/api/provider/lead_sources/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/lead_sources/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/lead_sources/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/lead_sources/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/lead_sources/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/lead_sources/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "lds-ab12C345DeF6",
  "name": "Online Ad2",
  "created_at": "2017-02-05T06:23:00-08:00",
  "updated_at": "2017-02-05T06:23:00-08:00"
}

Path Params

id
string
required

Unique Lead Source ID

Body Params

name
string

Response

Successful response

Suggest Edits

Delete Lead Source

 
deletehttps://api.staging.hint.com/api/provider/lead_sources/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/lead_sources/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/lead_sources/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/lead_sources/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/lead_sources/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/lead_sources/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Lead Source ID

Response

No content

 
Suggest Edits

List All Locations

 
gethttps://api.staging.hint.com/api/provider/locations
curl --request GET \
  --url https://api.staging.hint.com/api/provider/locations
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/locations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/locations");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/locations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "loc-ab12C345DeF6",
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "name": "San Francisco HQ",
    "phone_number": "5553050014",
    "virtual": false,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    }
  }
]

Response

Successful response

Suggest Edits

Create Location

 
posthttps://api.staging.hint.com/api/provider/locations
curl --request POST \
  --url https://api.staging.hint.com/api/provider/locations
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/provider/locations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/locations");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/locations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "loc-ab12C345DeF6",
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "name": "San Francisco HQ",
  "phone_number": "5553050013",
  "virtual": false,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  }
}

Body Params

name
string
required
address_line1
string
address_line2
string
address_city
string
address_state
string
address_zip
string
address_country
string
phone_number
string
virtual
boolean
location_group
object
 
location_group.id
string
required

Response

Successful response

Suggest Edits

Show Location

 
gethttps://api.staging.hint.com/api/provider/locations/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/locations/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/locations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/locations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/locations/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/locations/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "loc-ab12C345DeF6",
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "name": "San Francisco HQ",
  "phone_number": "5553050013",
  "virtual": false,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  }
}

Path Params

id
string
required

Unique Location ID

Response

Successful response

Suggest Edits

Update Location

 
patchhttps://api.staging.hint.com/api/provider/locations/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/locations/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/locations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/locations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/locations/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/locations/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "loc-ab12C345DeF6",
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "name": "San Francisco HQ",
  "phone_number": "5553050013",
  "virtual": false,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  }
}

Path Params

id
string
required

Unique Location ID

Body Params

name
string
required
address_line1
string
address_line2
string
address_city
string
address_state
string
address_zip
string
address_country
string
phone_number
string
virtual
boolean
location_group
object
 
location_group.id
string
required

Response

Successful response

Suggest Edits

Delete Location

 
deletehttps://api.staging.hint.com/api/provider/locations/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/locations/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/locations/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/locations/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/locations/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/locations/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Location ID

Response

No content

 
Suggest Edits

List All Patients

 
gethttps://api.staging.hint.com/api/provider/patients
curl --request GET \
  --url https://api.staging.hint.com/api/provider/patients
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/patients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/patients");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "health_insurance_group_id": "12345",
    "health_insurance_member_id": "A22222222",
    "health_insurance_payer_id": "00039",
    "health_insurance_payer_name": "Anthem Blue Cross California",
    "lead_source_other": "Downtown marketing event",
    "membership_status": "active",
    "uses_tobacco": false,
    "id": "pat-ab12C345DeF6",
    "age": 65,
    "created_at": "2017-02-05T06:23:00-08:00",
    "dob": "1952-01-01",
    "electronic_communication_consent_accepted": true,
    "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
    "email": "bass_man@bumble_bee_inc.com",
    "external_link_id": null,
    "first_name": "Gordon",
    "gender": "male",
    "hipaa_authorization_accepted": true,
    "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
    "import_id": null,
    "import_source": null,
    "joined_practice_date": "2017-02-05",
    "last_name": "Sumner",
    "middle_name": "Thomas",
    "name": "Gordon Thomas Sumner",
    "patient_agreement_accepted": false,
    "patient_agreement_accepted_at": null,
    "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
    "terms_accepted": false,
    "terms_accepted_at": null,
    "updated_at": "2017-02-05T06:23:00-08:00",
    "lead_source": {
      "id": "lds-ab12C345DeF6",
      "name": "Other",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00"
    },
    "phones": [],
    "integration_sync_status": null,
    "integration_error_message": null,
    "integration_web_link": null,
    "integration_last_synced_at": null,
    "integration_record_id": null,
    "company": {
      "id": "com-ab12C345DeF6",
      "name": "Schmoogle Inc."
    },
    "practitioner": null,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "practitioner_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    },
    "location": {
      "id": "loc-ab12C345DeF6",
      "address_city": "New York",
      "address_country": "United States",
      "address_line1": "157 E Houston St",
      "address_line2": "Suite 2402",
      "address_state": "NY",
      "address_zip": "10002",
      "name": "San Francisco HQ",
      "phone_number": null,
      "virtual": false,
      "location_group": {
        "id": "prg-ab12C345DeF6",
        "name": "Downtown Location Group",
        "created_at": "2017-02-05T06:23:00-08:00",
        "updated_at": "2017-02-05T06:23:00-08:00",
        "integration_record_id": null
      }
    },
    "memberships": [],
    "account": {
      "name": "Gordon Thomas Sumner",
      "past_due_in_cents": 0
    },
    "external_records": [],
    "ssn": {
      "masked_number": "***-**-1234"
    }
  }
]

Response

Successful response

Suggest Edits

Create Patient

 
posthttps://api.staging.hint.com/api/provider/patients
curl --request POST \
  --url https://api.staging.hint.com/api/provider/patients
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.staging.hint.com/api/provider/patients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.staging.hint.com/api/provider/patients");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "health_insurance_group_id": "12345",
  "health_insurance_member_id": "A22222222",
  "health_insurance_payer_id": "00039",
  "health_insurance_payer_name": "Anthem Blue Cross California",
  "lead_source_other": "Downtown marketing event",
  "membership_status": "active",
  "uses_tobacco": false,
  "id": "pat-ab12C345DeF6",
  "age": 60,
  "created_at": "2017-02-05T06:23:00-08:00",
  "dob": "1956-04-24",
  "electronic_communication_consent_accepted": true,
  "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
  "email": "bass_man@bumble_bee_inc.com",
  "external_link_id": null,
  "first_name": "Gordon",
  "gender": "male",
  "hipaa_authorization_accepted": true,
  "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
  "import_id": null,
  "import_source": null,
  "joined_practice_date": "2017-02-05",
  "last_name": "Sumner",
  "middle_name": "Thomas",
  "name": "Gordon Thomas Sumner",
  "patient_agreement_accepted": false,
  "patient_agreement_accepted_at": null,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
  "terms_accepted": false,
  "terms_accepted_at": null,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "lead_source": {
    "id": "lds-ab12C345DeF6",
    "name": "Other",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00"
  },
  "phones": [],
  "integration_sync_status": null,
  "integration_error_message": null,
  "integration_web_link": null,
  "integration_last_synced_at": null,
  "integration_record_id": null,
  "company": {
    "id": "com-ab12C345DeF6",
    "name": "Schmoogle Inc."
  },
  "practitioner": null,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "practitioner_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "location": {
    "id": "loc-ab12C345DeF6",
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "name": "San Francisco HQ",
    "phone_number": null,
    "virtual": false,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    }
  },
  "memberships": [
    {
      "enrollment_requested_on": "2017-02-05",
      "enrollment_status": "active",
      "member_type": "spouse",
      "start_date": "2017-02-05",
      "status": "active",
      "uses_tobacco": false,
      "end_date": null,
      "plan": {
        "id": "pln-ab12C345DeF6",
        "name": "Membership"
      },
      "company": null,
      "payer": {
        "id": "pat-ab12C345DeF6",
        "name": "Gordon Thomas Sumner"
      }
    }
  ],
  "account": {
    "name": "Gordon Thomas Sumner",
    "past_due_in_cents": 0
  },
  "external_records": [],
  "ssn": {
    "masked_number": "***-**-1234"
  }
}

Body Params

first_name
string
required
last_name
string
required
middle_name
string
title
string
email
string
gender
string
gender_other
string

Used to specify alternative gender preference

dob
string
lead_source
object
 
lead_source.id
string
required
practitioner
object
 
practitioner.id
string
required
location
object
 
location.id
string
required
phones
array of objects
id
number
type
us_formattable
ssn
object
 
ssn.number
string
health_insurance_group_id
string
health_insurance_member_id
string
health_insurance_payer_name
string
health_insurance_payer_id
string
address_line1
string
address_line2
string
address_city
string
address_state
string
address_zip
string
address_country
string
import_id
string

(deprecated)

import_source
string

(deprecated)

external_link_id
string

(deprecated)

integration_record_id
string
integration_error_message
string
integration_web_link
string
electronic_communication_consent_accepted
boolean
patient_agreement_accepted
boolean

Response

Successful response

Suggest Edits

Show Patient

Membership Status Options: unconfirmed, pending, active, unpaid, inactive, archived

 
gethttps://api.staging.hint.com/api/provider/patients/id
curl --request GET \
  --url https://api.staging.hint.com/api/provider/patients/id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/patients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/patients/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "health_insurance_group_id": "12345",
  "health_insurance_member_id": "A22222222",
  "health_insurance_payer_id": "00039",
  "health_insurance_payer_name": "Anthem Blue Cross California",
  "lead_source_other": "Downtown marketing event",
  "membership_status": "active",
  "uses_tobacco": false,
  "id": "pat-ab12C345DeF6",
  "age": 60,
  "created_at": "2017-02-05T06:23:00-08:00",
  "dob": "1956-04-24",
  "electronic_communication_consent_accepted": true,
  "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
  "email": "bass_man@bumble_bee_inc.com",
  "external_link_id": null,
  "first_name": "Gordon",
  "gender": "male",
  "hipaa_authorization_accepted": true,
  "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
  "import_id": null,
  "import_source": null,
  "joined_practice_date": "2017-02-05",
  "last_name": "Sumner",
  "middle_name": "Thomas",
  "name": "Gordon Thomas Sumner",
  "patient_agreement_accepted": false,
  "patient_agreement_accepted_at": null,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
  "terms_accepted": false,
  "terms_accepted_at": null,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "lead_source": {
    "id": "lds-ab12C345DeF6",
    "name": "Other",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00"
  },
  "phones": [],
  "integration_sync_status": null,
  "integration_error_message": null,
  "integration_web_link": null,
  "integration_last_synced_at": null,
  "integration_record_id": null,
  "company": {
    "id": "com-ab12C345DeF6",
    "name": "Schmoogle Inc."
  },
  "practitioner": null,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "practitioner_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "location": {
    "id": "loc-ab12C345DeF6",
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "name": "San Francisco HQ",
    "phone_number": null,
    "virtual": false,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    }
  },
  "memberships": [
    {
      "enrollment_requested_on": "2017-02-05",
      "enrollment_status": "active",
      "member_type": "spouse",
      "start_date": "2017-02-05",
      "status": "active",
      "uses_tobacco": false,
      "end_date": null,
      "plan": {
        "id": "pln-ab12C345DeF6",
        "name": "Membership"
      },
      "company": null,
      "payer": {
        "id": "pat-ab12C345DeF6",
        "name": "Gordon Thomas Sumner"
      }
    }
  ],
  "account": {
    "name": "Gordon Thomas Sumner",
    "past_due_in_cents": 0
  },
  "external_records": [],
  "ssn": {
    "masked_number": "***-**-1234"
  }
}

Path Params

id
string
required

Unique Patient ID

Response

Successful response

Suggest Edits

Update Patient

 
patchhttps://api.staging.hint.com/api/provider/patients/id
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/patients/id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.staging.hint.com/api/provider/patients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/patients/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients/id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "health_insurance_group_id": "12345",
  "health_insurance_member_id": "A22222222",
  "health_insurance_payer_id": "00039",
  "health_insurance_payer_name": "Anthem Blue Cross California",
  "lead_source_other": "Downtown marketing event",
  "membership_status": "active",
  "uses_tobacco": false,
  "id": "pat-ab12C345DeF6",
  "age": 60,
  "created_at": "2017-02-05T06:23:00-08:00",
  "dob": "1956-04-24",
  "electronic_communication_consent_accepted": true,
  "electronic_communication_consent_accepted_at": "2017-01-29T06:23:00-08:00",
  "email": "bass_man@bumble_bee_inc.com",
  "external_link_id": null,
  "first_name": "Gordon",
  "gender": "male",
  "hipaa_authorization_accepted": true,
  "hipaa_authorization_accepted_at": "2017-01-29T06:23:00-08:00",
  "import_id": null,
  "import_source": null,
  "joined_practice_date": "2017-02-05",
  "last_name": "Sumner",
  "middle_name": "Thomas",
  "name": "Gordon Thomas Sumner",
  "patient_agreement_accepted": false,
  "patient_agreement_accepted_at": null,
  "provider_web_link": "https://app.hint.com/patients/pat-ab12C345DeF6",
  "terms_accepted": false,
  "terms_accepted_at": null,
  "updated_at": "2017-02-05T06:23:00-08:00",
  "lead_source": {
    "id": "lds-ab12C345DeF6",
    "name": "Other",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00"
  },
  "phones": [],
  "integration_sync_status": null,
  "integration_error_message": null,
  "integration_web_link": null,
  "integration_last_synced_at": null,
  "integration_record_id": null,
  "company": {
    "id": "com-ab12C345DeF6",
    "name": "Schmoogle Inc."
  },
  "practitioner": null,
  "location_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "practitioner_group": {
    "id": "prg-ab12C345DeF6",
    "name": "Downtown Location Group",
    "created_at": "2017-02-05T06:23:00-08:00",
    "updated_at": "2017-02-05T06:23:00-08:00",
    "integration_record_id": null
  },
  "location": {
    "id": "loc-ab12C345DeF6",
    "address_city": "New York",
    "address_country": "United States",
    "address_line1": "157 E Houston St",
    "address_line2": "Suite 2402",
    "address_state": "NY",
    "address_zip": "10002",
    "name": "San Francisco HQ",
    "phone_number": null,
    "virtual": false,
    "location_group": {
      "id": "prg-ab12C345DeF6",
      "name": "Downtown Location Group",
      "created_at": "2017-02-05T06:23:00-08:00",
      "updated_at": "2017-02-05T06:23:00-08:00",
      "integration_record_id": null
    }
  },
  "memberships": [
    {
      "enrollment_requested_on": "2017-02-05",
      "enrollment_status": "active",
      "member_type": "spouse",
      "start_date": "2017-02-05",
      "status": "active",
      "uses_tobacco": false,
      "end_date": null,
      "plan": {
        "id": "pln-ab12C345DeF6",
        "name": "Membership"
      },
      "company": null,
      "payer": {
        "id": "pat-ab12C345DeF6",
        "name": "Gordon Thomas Sumner"
      }
    }
  ],
  "account": {
    "name": "Gordon Thomas Sumner",
    "past_due_in_cents": 0
  },
  "external_records": [],
  "ssn": {
    "masked_number": "***-**-1234"
  }
}

Path Params

id
string
required

Unique Patient ID

Body Params

first_name
string
required
last_name
string
required
middle_name
string
title
string
email
string
gender
string
gender_other
string

Used to specify alternative gender preference

dob
string
lead_source
object
 
lead_source.id
string
required
practitioner
object
 
practitioner.id
string
required
location
object
 
location.id
string
required
phones
array of objects
id
number
type
us_formattable
ssn
object
 
ssn.number
string
health_insurance_group_id
string
health_insurance_member_id
string
health_insurance_payer_name
string
health_insurance_payer_id
string
address_line1
string
address_line2
string
address_city
string
address_state
string
address_zip
string
address_country
string
import_id
string

(deprecated)

import_source
string

(deprecated)

external_link_id
string

(deprecated)

integration_record_id
string
integration_error_message
string
integration_web_link
string
electronic_communication_consent_accepted
boolean
patient_agreement_accepted
boolean

Response

Successful response

Suggest Edits

Delete Patient

 
deletehttps://api.staging.hint.com/api/provider/patients/id
curl --request DELETE \
  --url https://api.staging.hint.com/api/provider/patients/id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.staging.hint.com/api/provider/patients/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.staging.hint.com/api/provider/patients/id");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
string
required

Unique Patient ID

Response

No content

Suggest Edits

IntegrationRecord

 
Suggest Edits

List all IntegrationRecords for a Patient

 
gethttps://api.staging.hint.com/api/provider/patients/patient_id/integration_records
curl --request GET \
  --url https://api.staging.hint.com/api/provider/patients/patient_id/integration_records
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/patients/patient_id/integration_records' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients/patient_id/integration_records")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/patients/patient_id/integration_records");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients/patient_id/integration_records"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "integration_record_id": "ABCD0012016",
    "partner": {
      "name": "HealthifyEMR13"
    }
  }
]

Path Params

patient_id
string
required

Unique Patient ID

Response

Successful response

Suggest Edits

SocialSecurityNumber

 
Suggest Edits

Show Social Security Number

 
gethttps://api.staging.hint.com/api/provider/patients/patient_id/social_security_number
curl --request GET \
  --url https://api.staging.hint.com/api/provider/patients/patient_id/social_security_number
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.staging.hint.com/api/provider/patients/patient_id/social_security_number' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/patients/patient_id/social_security_number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/patients/patient_id/social_security_number");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/patients/patient_id/social_security_number"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "number": "808561234",
  "formatted_number": "808-56-1234"
}

Path Params

patient_id
string
required

Unique Patient ID

Response

Successful response

Suggest Edits

List All Plans

 
gethttps://api.staging.hint.com/api/provider/plans
curl --request GET \
  --url https://api.staging.hint.com/api/provider/plans
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/plans' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/plans");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/plans"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "pln-ab12C345DeF6",
    "name": "Memberships"
  }
]

Response

Successful response

 
Suggest Edits

Get Practice

 
gethttps://api.staging.hint.com/api/provider/practice
curl --request GET \
  --url https://api.staging.hint.com/api/provider/practice
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.staging.hint.com/api/provider/practice' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/practice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.staging.hint.com/api/provider/practice");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/practice"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "name": "Hint Health Clinic",
  "address_city": "New York",
  "address_country": "United States",
  "address_line1": "157 E Houston St",
  "address_line2": "Suite 2402",
  "address_state": "NY",
  "address_zip": "10002",
  "email": "hintclinic@example.com",
  "logo_url": "https://www.hint.com/logo.png",
  "url": "https://www.hint.com",
  "phones": [
    {
      "number": "4158546466",
      "type": "Mobile",
      "us_formattable": true
    }
  ],
  "integration_record_id": null
}

Response

Successful response

Suggest Edits

Update Practice

 
patchhttps://api.staging.hint.com/api/provider/practice
curl --request PATCH \
  --url https://api.staging.hint.com/api/provider/practice
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.staging.hint.com/api/provider/practice' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.staging.hint.com/api/provider/practice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.staging.hint.com/api/provider/practice");

xhr.send(data);
import requests

url = "https://api.staging.hint.com/api/provider/practice"

response = requests.request("PATCH", url)

print(response.text)