Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2025-01-24
Steps: Build Custom Apps with REST API

Steps: Build Custom Apps with REST API

Administrator
 access in Peakon.
You can use a Peakon-provided, external REST API to build custom applications and integrations for employee provisioning and access resources otherwise only exposed with the Peakon dashboard.
Review the resources in the API documentation. Visit: https://developer.peakon.com/
  1. On the Peakon tenant, navigate to
    Administration
    Integrations
    Custom Apps
    .
  2. Name your application and create permissions.
    Peakon recommends that you grant minimum permissions for your applications.
  3. Copy the
    Access Token
     generated.
    The token is the only credential used by your application to access remote resources in Peakon and displays only once. Peakon recommends that you keep it safe, and don't share with other applications.
  4. Call the POST /v1/auth/application endpoint.
    Specify the generated access token in the request body of the POST /v1/auth/application endpoint. In response to a successful authentication request, this endpoint returns a JSON Web Token. For details, see the Authenticate application endpoint in the Peakon API Reference.
  5. Embed the JWT token in the Authorization header of subsequent API requests.
    The separation of authentication and authorization tokens enables a deployment where only an application developer or a company admin has access to the authentication token. Assign and share authorization tokens with application users.
  6. Send the appropriate Peakon API requests from your new application.
    You can send a request with additional parameters. Example: Filter out data or specify a time interval. For a list of API endpoints and their parameters, see the Peakon API Reference.