TallyPip
Start free

API reference

Connection

Which business and person a key acts for. Ask for it to check a key works, and to show the business's name in your app.

The connection object

object string
Always "connection".
business object
id, name, country (US or CA), currency (USD or CAD) and sandbox (true for a developer's sandbox business) of the business the key belongs to.
key object
id, kind (key, or connection for an app connected with Connect to TallyPip), name, starts_with (its first 10 characters) and access (read or write) of the key or access token used.
acting_as object
name and role (owner, admin, accountant or standard) of the person who made the key: requests act as them.

Example

{
  "object": "connection",
  "business": {
    "id": "3f6c1e2a-8b4d-4c1e-9a7b-2d5e6f708190",
    "name": "Oak Street Dental",
    "country": "US",
    "currency": "USD",
    "sandbox": false
  },
  "key": {
    "id": "3f6c1e2a-8b4d-4c1e-9a7b-2d5e6f708191",
    "kind": "key",
    "name": "Zapier",
    "starts_with": "tpk_Ab12Cd",
    "access": "write"
  },
  "acting_as": {
    "name": "Jordan Lee",
    "role": "owner"
  }
}

Check a key

GET /api/v1/me

Which business and person the key acts for. Use it to check a key works.

Key: any (Read only works).

Request

curl https://tallypip.com/api/v1/me \
  -H "Authorization: Bearer tpk_your_key"

Answer: 200

{
  "object": "connection",
  "business": {
    "id": "3f6c1e2a-8b4d-4c1e-9a7b-2d5e6f708190",
    "name": "Oak Street Dental",
    "country": "US",
    "currency": "USD",
    "sandbox": false
  },
  "key": {
    "id": "3f6c1e2a-8b4d-4c1e-9a7b-2d5e6f708191",
    "kind": "key",
    "name": "Zapier",
    "starts_with": "tpk_Ab12Cd",
    "access": "write"
  },
  "acting_as": {
    "name": "Jordan Lee",
    "role": "owner"
  }
}

Try it

With your own key (Settings › Connected apps). It stays in this page only, and reading can't change anything.