Skip to content

Read API

Your department’s data in your own systems

Your admins make read-only tokens, and your systems read the roster, CVs and reports.

The API access card on a department’s Settings page, with a token’s name, what it reads and when it ends, a read of the roster in code, and that read in a person’s activity log.

How it works

  1. Make a token

    An admin names it, picks what it reads and sets its end, from 7 days to 1 year.

  2. Choose what it reads

    Roster, CVs or reports. A token answers with what its maker may see, and nothing more.

  3. Read the reference

    The public reference lists each request your systems can make, with page sizes, rate limits and error codes.

  4. Every read is logged

    Each CV read shows in that person’s activity, with the token’s name and its maker.