API v1 (deprecated) - Prophia Docs

API v1 is deprecated. It still works, but it won’t get new features. Build new integrations on API v2, and plan to move existing ones.

Base URL

https://api.prophia.com/rest/v1

Authentication

Send your API key in the X-API-Key header. See Authentication for key types.

curl https://api.prophia.com/rest/v1/accounts \
  -H "X-API-Key: <your-api-key>"

v1 also accepts the key as an api_key query parameter. Avoid it, because URLs end up in logs.

Looking up records

Path IDs take the Prophia ID or your own custom ID. A custom ID is looked up in the account your API key belongs to.
The account endpoints take an optional account_id, which can be the Prophia ID or the account’s API name. Leave it out to use your key’s account.