API reference

The PeopleOS API is organized around REST. Our API has predictable resource-oriented URLs.

You can not use the PeopleOS API in test mode. This means all requests will be processed towards your production account. Please be cautious.

The PeopleOS API doesn’t support bulk updates. You can work on only one object per request.

Base URL

Code


      https://peopleos.cloud/api

If you want to test the API yourself, we provide two convenient tools for you to use: Yaak and Bruno .

The documentation is included in the Github repository, under the docs folder.

Why these tools? Because they're fresh, new, free and open source under the MIT license, and I really like their ethos.

There is no strict standard for JSON payloads, but we do try to follow the JSON:API specification , which defines a structured format for responses.

Please login to vote.

It's free and will help us improve the page.

Taylor will be proud of you.

Last updated on June 30, 2025.