Home > Documentation

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

Test the API yourself

If you want to test the API yourself, we provide a Yaak collection for you to use, as a workspace.

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

Why Yaak? Because it's a fresh, new approach to API clients, it's free and open source under the MIT license, and I really like the ethos of the main developer. You should give it a try.

Taylor Swift being happy

Please login to vote.

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

Taylor will be proud of you.

Last updated on April 5, 2025.