Using the Person API

Information on using the Person API.

Consumers of the Person API will need a client, in their language of choice, capable of calling a REST API. The Person API is a  JSON:API compliant API, so many clients that can handle JSON:API should work with it.

To manually test the API we recommend using Postman  . Please refer to our documentation on the Person API Postman Collection for more information.

JSON:API Clients

JSON:API maintains a list of clients in a variety of languages. The following clients have been tested with the Person API:

  • Java:
    • jsonapi-converter - JSONAPI-Converter is a library that provides means for integrating with services using JSON API specification.
  • Javascript:
  • json-api-models - A lightweight layer for working with JSON:API data.
  • Python:
  • jsonapi-client - This Python (3.6+) library provides easy-to-use, pythonic, ORM-like access to JSON API.

If you have used other JSON:API clients with the Person API, please let us know at api@doit.wisc.edu and we will add them to this list.

IICS Integration

Person API IICS Tutorial - Demonstrates how to create a connection within Informatica Intelligent Cloud Services Cloud Data Integration (IICS CDI) using the RESTv2 connector to connect to the Person API.

Person API Examples

For examples of how the Person API is in use today, please see the following:

If you have created a client or application for the Person API and would like to share it, please let us know at api@doit.wisc.edu and we will add it to this list.



Keywords:
person-api 
Doc ID:
158492
Owned by:
Jared K. in DoIT Enterprise Integration - API Team
Created:
2026-02-10
Updated:
2026-02-10
Sites:
DoIT Enterprise Integration - API Team