Skip to main content

API: Getting Started with Cayuse APIs

Emily Yeomans
  • Updated

Cayuse APIs enable you to integrate with Cayuse products and automate common workflows. Use the links below to find the documentation for the API you need.

Available APIs

Select the API documentation for the Cayuse product you're integrating with.

API Description View
Admin APIs Configure administrative settings and system-level resources. Admin Module APIs
Platform HR Connect APIs Core platform services including authentication, users, organizations, and HR Connect. Platform HR Connect APIs 
Public APIs Additional APIs available for supported Cayuse products and integrations. Public APIs
Sponsored Projects APIs Access proposals, awards, projects, investigators, and research administration data. Sponsored Projects Public APIs

Getting Started

Before making API calls, you must authenticate with the Cayuse Login Service to obtain a JSON Web Token (JWT). This token is required for all Cayuse API requests.

Authentication uses Basic Authentication against the /basicauth endpoint and requires:

  • Username
  • Password
  • Tenant ID (provided during implementation)

Authentication Request

Type Value Description
Method GET  
URL https://signin.cayuse.com/basicauth URL of the authentication API (see note)
Header: Authorization 
Basic {BA encoded credentials}
 Standard Basic Auth header
Query String Parameter 
tenant_id={your Tenant ID}
 Specifies the tenant to use during authentication

Example Authentication Request

# Provide the following values
USERNAME=exampleuser
PASSWORD=examplepassword
TENANT_ID=1010abab-10ab-10ab-10ab-10ab10ab10ab

curl -i --basic --user $USERNAME:$PASSWORD \
https://signin.cayuse.com/basicauth?tenant_id=$TENANT_ID

A successful request returns a JSON Web Token (JWT), which must be included in all subsequent API requests.

Making API Calls

All API requests require the following headers:

Header Value
Authorization Bearer <JWT>
Content-Type application/json
X-IDP-New-Login true

Example API Request

TOKEN=eyJraWQiOiJmNGJlN2UzYj...

curl \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-H "X-IDP-New-Login: true" \
https://developer.cayuse.com/v1/proposals

Related articles