PeopleForce

Deprecated

Company API v1 is deprecated and will be removed in a future release. Migrate to a newer version — v4 is the latest. Use the version switcher in the header.

FAQ

Our favourite questions from users.

Is using the API free?

No — the API and webhooks come with the Professional plan. On Standard, the API keys and Webhooks pages don't appear in Settings.

During a free trial you can create API keys whichever plan the trial is for. Webhooks need a trial on Professional. If you subscribe on Standard when the trial ends, every API key and webhook you created is switched off.

What are the API rate limits?

The current limit is 300 requests per minute. See Rate limits for details.

I don't see Webhooks, API, or Settings in PeopleForce

These pages are only visible to admin users, or users with the webhook or API permission. Contact your PeopleForce administrator to request access.

API keys and Webhooks also need the Professional plan — see Is using the API free?.

I found a bug / I got a 500 error

Sorry to hear it — we aim for the best quality in our product. If you hit an issue, let us know and we'll work on it. A 500 response automatically notifies our team, but you're still welcome to write in and describe what happened — it helps us resolve it faster, and we'll let you know once there's a fix.

I couldn't find the endpoint or data I was looking for

We cover a wide range of cases across the API and webhooks, but maybe yours is new to us. Let us know and we'll do our best to help — see also Request a feature.

On this page