What is the Appficient API?

With the Appficient API you automate anything you can also do by hand in Appficient: create clients, send invoices, follow up quotes, move deals and more. It is a REST API with JSON, API keys and predictable responses.

Create an API key

Sign in to Appficient and open Settings, then API. Create a new key and grant only the scopes your integration needs. Keys always start with apf_.

Store your key safely

You see the full key once, right after creation. Keep it in a secrets manager or environment variable — never in code or version control.

Your first request

All requests go to:

bash

https://api.appficient.nl

First check that you can reach the API. No key required:

bash

curl -sS https://api.appficient.nl/v1/ping

json

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Then call with your key. This endpoint shows which key you use and which scopes it has:

bash

curl -sS https://api.appficient.nl/v1/me \
  -H "Authorization: Bearer apf_your_key_here"

json

{
  "data": {
    "surface": "extern",
    "actor": {
      "type": "api_key",
      "label": "Integratie"
    },
    "scopes": [
      "invoices.read",
      "invoices.write"
    ]
  },
  "meta": {}
}

If you see this response, your integration works. Congratulations!

Next steps

Authentication: how to send the key and what never to do.
Conventions: how requests and responses are shaped (envelope, pagination, filters).
Invoices: the most common starting point. List invoices with one GET.