Overview

This article explains how to reach and use the Jive REST API v3 endpoints.

Solution

Assuming that your Jive instance has address https://community.yourdomain.com, the Jive API main base URL is located at https://community.yourdomain.com/api/core/v3/.

Navigating to this URL will not show anything, though, as you need to add one of the endpoints listed at the official API v3 documentation, for example, "people": the end link would be: https://community.yourdomain.com/api/core/v3/people.

You can try this URL in your browser and will return a list of people in your instance, in JSON format. For example:

Note: If you are trying this in your browser, you should already be authenticated with a valid user from your Jive community. If you are trying this using an API query tool like Postman or Insomnia, you will have to choose Basic Authentication and enter a valid username and password. The actions available will be limited as per what the authenticated user is allowed to do.

Beware that if you have more than 25 users in your community, by default this call will return only the first 25 items. You need to add the parameters startIndex and itemsPerPage in order to recursively get all the results. This behavior is common to most API calls, and it is enforced in order to lessen the load on the community that is generated by API usage. Keep in mind that the itemsPerPage has a maximum value of 100, for the same reason just described.

In addition to the documentation, other resources are available in the Jive Developer Resources.