Account

Get the current API key

GET/api/v1/me

Returns the API key making the request (its name, mode and permissions) and the organization it belongs to. A quick way to check that a key works and what it may do.

Needs a key with read permission.

Request

This request takes no parameters and no body.

Response

The key and its organization. Status 200.

Response fields
Name	Type	Description
id	string	An ID that starts with key_.
object	string	Always `api_key`.
name	string
mode	string	One of: `test`, `live`.
permissions	array of string	Each item is one of: `read`, `submit`.
organization	object
organization.id	string	An ID that starts with org_.
organization.object	string	Always `organization`.
organization.name	string

Errors

Errors
HTTP status	Code	What it means
401	UNAUTHORIZED	A valid API key is required. Send it as "Authorization: Bearer <key>".
403	PERMISSION_DENIED	This API key is not allowed to do that.
422	INVALID_REQUEST	The request is not valid.
504	TIMEOUT	The request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500	INTERNAL	Something went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell

curl "https://sandbox.myclaimhouse.com/api/v1/me" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "id": "key_01JM000000E008000000000002",
  "object": "api_key",
  "name": "Example integration (test)",
  "mode": "test",
  "permissions": [
    "read",
    "submit"
  ],
  "organization": {
    "id": "org_01JM000000E008000000000001",
    "object": "organization",
    "name": "Example Dental Group"
  }
}