/
CH
charthop
/
ChartHop API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 7h ago · Updated 7h ago
33fc84a173ce
latest
Swagger 2.0
2026-08-13
751
689
2.0 MB
access
2
get
Return the appropriate actions that can be performed on an entity or set of entities
get
Return the appropriate actions that can be performed on the ui.
action
7
get
Return all actions in the organization paginated
post
Create an action
post
Delete a set of actions
get
Return a particular action by id
delete
Delete an action
patch
Update an existing action
post
Run an action - for testing
ai
24
get
List memories for an agent
post
Create a new memory
get
Get a single memory
delete
Delete a memory
patch
Update a memory
get
Retrieve previous AI chats
post
Start a new AI chat with an initial message or question
get
Retrieve some suggested prompts for starting an AI chat
get
Find users with the most AI chats over a date range
get
Retrieve a previous AI chat
delete
Delete an AI chat
patch
Update an existing AI chat's metadata, such as label or shareAccess information
post
Answer a pending AskUserQuestion tool call in an AI chat
post
Approve pending tool calls in an AI chat
post
Send an additional message to an existing AI chat
get
Retrieve an individual message from an existing AI chat
post
Send feedback on a message in an AI chat
post
Reject pending tool calls in an AI chat
patch
Update configuration of AI models for this org (ChartHop staff only)
post
Use AI to generate a summary of text form responses
post
Translate from one language to another using AI
post
Detect the dominant language of a text
post
Translate natural language into a CQL filter expression
delete
Invalidate all cached expression translation responses
ai-credit-limit
7
get
Find AI credit limits, optionally filtered by customer
post
Create an AI credit limit
get
Get an AI credit limit by customer and month
post
Export the AI credit usage report as CSV (ChartHop staff only)
get
Get an AI credit limit by id
delete
Delete an AI credit limit
patch
Update an AI credit limit
ai-hint
6
get
Find hints
post
Create a hint
get
Generate placeholder hint content for a given tool and entity type
get
Get a hint
delete
Delete a hint
patch
Update a hint
ai-prompt
7
get
Find prompts
post
Create a prompt
post
Test a prompt
get
List prompt types
get
Get a prompt
delete
Delete a prompt
patch
Update a prompt
allocation
5
get
Get the allocations to a group on a date -- one entry per allocated job
post
Create or update allocations to a group, keyed on (jobId, groupId, effectiveDate)
get
Get a job's allocations on a date, across every group type
delete
Delete an allocation -- for a record that should never have existed; to stop an allocation, PATCH its endDate instead
patch
Update an allocation by record id
app
27
get
Return all publicly visible global apps
post
Create a new app
get
Get all active installs of this app
get
Return a particular app by name
post
Send an email notification to the configured notify users, on behalf of an app
get
Return all active apps available for a particular org
get
Find installed app users
post
Install an app for a particular org
get
Get an installed app by name
post
Validate the installation of an app for a particular org
get
Get an installed app
delete
Uninstall an app
patch
Update the settings of an installed app
post
Execute one configured external API operation against the live external service (the app config 'Test' action). Requires readExternal for a read-only operation, writeExternal otherwise; a non-read-only operation runs against the live API and may create, change, or delete real data.
post
Retrieve an Oauth2 authorization code for this app, which can be exchanged for an access token
get
List an installed agent's active MCP connections (one per connected user token)
delete
Revoke MCP connections for an installed agent
post
Disable automatic sync for an app installation whose credentials are failing
get
Retrieve the current token for this app
post
Force-refresh the vendor OAuth token for an app installation
post
Run an installed app
get
Retrieve the current token for this app
post
Generate or regenerate a long-lived access token for the app
post
Move a Greenhouse installation onto the config-driven Greenhouse API (or back off it)
get
Return a particular app by id
delete
Delete an app
patch
Update an existing app
appConfig
4
post
Create a new app config
get
Return default app configuration by app
get
Return user app configuration by app and user
patch
Update an existing app
approval
21
get
Return approval chains
post
Create an approval chain
get
Return a particular approval chain by id
delete
Delete a approval chain
patch
Update a approval chain
post
Duplicate an approval chain including all of its stages and settings
post
Export an approval chain's stages to CSV format
get
Return all approval requests for an approval chain
post
Create an approval request
get
Return all approval request comp review responses for an approval chain
get
Return all approval request scenario responses for an approval chain
get
Return an approval request
delete
Delete an approval request
patch
Update an existing approval request
post
Reassigning an approver at a stage
post
Send a reminder for a stage reviewer in an existing approval request
get
Return all approval chain stages for an approval chain
post
Create an approval chain stage
get
Return all approval chain stages for an approval chain
delete
Delete an approval chain stage
patch
Update an existing approval chain stage
approval-delegate
6
get
List the acting user's approval delegates
get
List every approver's delegates in the org, grouped by approver and enriched with user/job refs
post
Set or remove approval delegates on behalf of users in a single atomic batch
get
List the approvers the acting user is a delegate for
put
Set (or replace) the delegate for the given approval type
delete
Remove the delegate for the given approval type
approval-request
4
get
Return all approval request scenario responses for an org
get
Return a particular approval request timeoff response by entity id
get
Return a particular approval request scenario response by jobId
get
Return a particular approval request scenario response by id
assessment
17
get
Return all assessments in the organization paginated
post
Create a assessment
post
Delete a set of assessments
post
Duplicate a set of assessments
post
Update the types of a set of assessments
get
Return a particular assessment by id
delete
Delete a assessment
patch
Update an existing assessment
post
Release all un-approved responses for a form of an assessment
post
Export calibration details to a CSV file as an async process
get
Retrieve all persons who were targets of form submissions, retrieving both fields as well as question responses. This endpoint is typically used for calibrations.
post
Complete a assessment
post
Expire all pending tasks for a form of an assessment
get
Return an overview of the forms and questions used in the assessment. If the user has read access to the assessment, then the forms and questions are visible, even if they would not otherwise be visible on their own
post
Reactivate a assessment
post
Release all un-released responses for a form of an assessment
get
Return a summary of the tasks for a given assessment
band
10
get
Find comp bands in the organization
post
Create a comp band
delete
Delete all comp bands on a date
post
Perform a bulk update on comp bands
get
Return the count of comp bands in the organization
delete
Delete all comp band data on a date
get
Get comp band schema with job tier field configurations and their possible values
get
Return a particular comp band by id on an effective date
delete
Delete a comp band
patch
Update a comp band
billing
3
get
Return billing information for a customer
post
Cancel a subscription for a customer
post
Checks out customer to upgrade to pay for their subscription
budget
9
get
Find budgets
post
Create a new budget
get
Calculate potential budget usage, for use while creating/setting budgets
get
Get a budget by id or slug
delete
Delete a budget
patch
Update an existing budget
get
Get a budget's baseline history (the frozen amount steps from activation onward)
get
Get a budget's baseline value over time (step line + re-baseline markers) for the variance chart
get
Per-job (filled + open) cost breakdown contributing to a budget, with per-month detail
budget-pool
7
get
Get all budget pools for an org
post
Create a new budget pool
get
Get a specific budget pool
delete
Delete a budget pool
patch
Update a budget pool
get
Get the guidelines associated with a budget pool
get
Generate tiering & preview with the given budget calculated for the compensation review
calendar
18
get
Return calendar entries in a given time period
get
Return calendars visible to the current user
post
Create a new calendar
get
Returns calendar events visible to the current user with exclusive end dates
post
Create a new calendar entry
get
Returns calendar events, condensed when there are too many of a single entry on a particular day
get
Returns calendar events in iCalendar format
post
Import calendar events from CSV file
get
Download a CSV template for calendar event import
get
Return a particular calendar entry by id
delete
Delete a calendar entry
patch
Update an existing calendar entry
get
Return a particular calendar by id
delete
Delete a calendar
patch
Update an existing calendar
get
List employees who match this holiday calendar and at least one other, with every calendar they match
get
List every employee a holiday calendar could apply to, as job-data rows annotated with an `_eligible` flag
get
Returns calendar events visible to the current user in a calendar
category
5
get
Return categories that are available to the organization
post
Create a category
get
Return a particular category by id
delete
Delete a category
patch
Update an existing category
category-sort
6
get
Return category sort order
put
Create or update category sort order for a given org and return the sort data
post
Create a category sort order if it doesn't exist
delete
Delete a category sort order
patch
Update an existing category sort order
post
Create or update category sort order for a given org and return the sort data
change
16
get
Return recent changes across an org, or for a particular person or job
post
Perform a series of changes at once
post
Perform a bulk update on a number of jobs
get
Return enriched compensation history rows (one row per comp change), in descending date order
post
Create a depart-rehire pair of changes, for filling in historical data
get
Return all changes for a particular scenario, with before job
post
Sync a change (create the change only if it does not already exist)
get
Return a particular change by id
delete
Delete a previous change
patch
Make a change to a change
post
Approve or reject a change
get
Given a of change id, see if the person can approve/reject
post
Create a new change
post
Validate a change
patch
Amend a change within a scenario, and potentially return the updated data
get
Get the status of a running change within a scenario
comment
7
post
Post a comment
get
Return comments on changes within a comp review, paginated
get
Return comments on a particular entity paginated
get
Return comments on a scenario and the changes within, paginated
get
Return a particular comment by id
delete
Delete a comment
patch
Update a comment
comp-review
28
get
Find comp reviews in the organization
post
Create a comp review
post
Delete a set of comp reviews
post
Duplicate a set of comp reviews
get
Return a particular comp review by ID
delete
Delete a comp review
patch
Update a comp review
get
Get a list of approval request responses for a given comp review
patch
Update approval request status, including any rollups
get
Get the necessary caches on a specific date for a compensation review
get
Return past events, paginated, without payloads present
post
Concludes (or closes) the compensation review
post
Preview changes that will occur when resuming a paused comp review
post
Duplicate a comp review
get
Get a list of employees eligible for a given comp review
post
Export a comp review's changes
post
Export a comp review's audit log
post
Export a comp review's comments
post
Generate a compensation review
get
Get an overview for a given user in an in-cycle comp-review
get
Get the changes for a set of scenarios in an in-cycle comp-review
get
Get the change data and guideline flags associated with an in-cycle change
get
Get a collaborator participant reviewer in-cycle comp-review
get
Return metadata for a particular comp review by ID
post
Pauses the compensation review to allow for editing by an admin
post
Generate tiering & preview for a compensation review
post
Send a reminder email to someone participating in a comp review
post
Get data for visualizations for a comp review
content
9
get
Return all content in the organization paginated
post
Create a new piece of content
patch
Update the homepage content
get
Render the contents of the homepage
get
Return a particular content by path
get
Return a particular content by path, and render its contents
get
Return a particular content by id
delete
Delete a content
patch
Update an existing piece of content
customer
7
get
Return all visible customers, paginated by name
post
Create a new customer
get
Return a particular customer by id
patch
Update an existing customer
get
Returns a list of all the invoices for the given customer
get
Returns information about the Charthop subscription for the given customer
patch
Update a subscription on a customer
data-view
5
get
Return all data views in the organization paginated
post
Create a data view
get
Return a particular data view by id
delete
Delete a data view
patch
Update an existing data view
email-template
5
post
Create a new email template
get
Return all essential email templates
get
Return the email template by name
get
Return all non-essential email templates
patch
Update an existing email template
event
5
get
Return past events, paginated, without payloads present
post
Create an inbound event
post
Create an outbound event
get
Return individual event, including payload
post
Resend all associated notifications for a previous event (superusers only)
exchange-rate
7
get
Return the exchange rates on a particular date
delete
Delete a custom exchange rate on a particular date
patch
Update the USD-based exchange rates for a particular date. Must be the first of a month.
get
Return org custom exchange rates
post
Bulk update custom currency rates in org custom exchange rates
get
Return the global exchange rates based on USD for a particular date
get
Return org custom exchange rates
export
13
post
Export a changelog to CSV format
post
Export compensation history (one row per comp change, enriched with title/manager/department) to CSV format
post
Export a CSV of custom fields
post
Export a CSV changelog of a scenario
post
Export a csv log of a scenario comments
post
Export the org's scenario list to CSV format
post
Export a snapshot of a current roster to CSV format
post
Export tasks for a review to CSV format
post
Export users for a review to CSV format
post
Export a roster to JSONL format; pass series=CHANGES with startDate/endDate for a per-date change series
post
Export reviews in PDF format
post
Export org chart to Powerpoint
post
Export report to Powerpoint
expression
2
post
Evaluate carrot expression
post
Validate carrot expression(s)
field
13
get
Return all fields in the organization paginated
post
Create a field
get
Get built-in fields
get
Return uncategorized fields
get
Return fields in a particular category
delete
Delete fields
post
Remove field from all associated categories
post
Remove overrides from fields
post
Update status for existing fields
get
Return a particular field by id
delete
Delete a field
patch
Update an existing field
patch
Perform a dry-run of an update to an existing field that will require migrations
file
9
get
Returns a list of files
post
Upload a new file
get
Query files with additional person field data
post
Export a zipfile of files matching some criteria
post
Export a CSV of file metadata matching some criteria
get
Returns metadata about a file
delete
Delete a file
patch
Update a file's metadata
get
Download a file
form
19
get
Return all forms in the organization paginated
post
Create a form
get
Return all active forms applicable to a particular entity
delete
Delete forms
get
Return all active forms applicable to a particular person
post
Update status for existing forms
get
Return a particular form by id
post
Submit data from a form
delete
Delete a form
patch
Update an existing form
post
Collect data for an existing form, sending emails and chat notifications to people being requested
get
Get the current state of form draft data
post
Duplicate a form
post
Render a preview of a form
post
Sends reminder for a form with existing tasks, sending emails/chat notifications to people being requested
get
Render a form for display
post
Re-render form blocks based on changes to the form values
post
Submit data from a form
post
Submit data from a form draft
form-response
14
get
Return form responses by form
get
Return the total count of form responses
post
Export form responses
post
Import form response data from CSV file
get
Download a CSV template for a form import
get
Return a particular form response by id
post
Update an existing form response's answers without re-submitting
delete
Delete a form response
patch
Update an existing form response's metadata, such as shareAccess information
post
Approve a form response
get
Export a particular form response as a PDF document
post
Reject a form response
post
Release a form response
post
Request changes for a form response
goal
8
get
Find goals
post
Create a new goal
post
Export goals to CSV format
get
Get a goal by id
delete
Delete a goal
patch
Update an existing goal
post
Copy a goal and its targets into a new goal
get
Find parent and child goals, from a starting goal id
goal-type
5
get
Find goal types
post
Create a new goal type
get
Get a goal type by id
delete
Delete a goal type
patch
Update an existing goal type
goalProgress
5
get
Find goal progress for a goal
post
Create a new goal progress update
get
Get a goal progress by id
delete
Delete a goal progress
patch
Update an existing goal progress
goalTarget
6
get
Find goal targets for a goal
post
Create a new goal target
get
Get a goal target by id
delete
Delete a goal target
patch
Update an existing goal target
get
Get a goal target's current actual value
group
18
get
Find groups in the organization of a certain type
post
Mark multiple groups as deleted
get
Get organized group counts
get
Find groups in the organization of a certain type
post
Import data from CSV file
get
Download a CSV template for group import
post
Undelete groups
get
Return a particular group by id
delete
Delete a group
patch
Add members to a grouip
get
Check whether a group is eligible to be deleted from history
post
Combine two groups together, including updating the historical record so that the two groups were never different
get
Get the history of changes for each field on a group
delete
Permanently delete a group from history
patch
Remove members from a grouip
get
Render the group description, resolving Carrot template expressions to live data
post
Create a group
patch
Update a group
group-type
5
get
Return all groups in the organization paginated
post
Create a group type
get
Return a particular group type by id
delete
Delete a group
patch
Update an existing group
guideline
6
get
Get all guidelines for a given comp review
post
Create a new guideline
get
Get a specific guideline
delete
Delete a guideline
patch
Update a guideline
get
Calculate the matrix values for a specific guideline (which may apply to multiple scenarios in the comp review)
import
6
post
Import data from CSV file
post
Import data from CSV file
post
Import data from CSV file
post
Parse a CSV file in preparation for column matching as part of spreadsheet import process
post
Import time off balance data from CSV file
post
Check if a spreadsheet file is valid to be imported
job
13
get
Find jobs in the organization
post
Create a job
post
Perform a bulk update on a number of jobs
get
Count jobs or people in the organization
get
Retrieve jobs from a region of the job graph
get
Find jobs in the organization, grouped by an expression
get
Find jobs by person ids
get
Compute top-N + Other subcounts for one or more fields, for jobs in the organization
get
Find jobs in the organization returned as a time-series
get
Compute aggregated totals for jobs matching a query
get
Return a particular job by id
delete
Delete a job
patch
Update a job
job-code
11
get
Return all job codes in the organization paginated
post
Create a job code
post
Export job codes
post
Import data from CSV file
get
Download a CSV template for a job code import
get
Return all job code linked field IDs
post
Start an async process that uses AI to suggest a JobCode for each job that does not yet have one. Poll GET /v1/org/{orgId}/process/{processId} for status; suggestions are written to process.results once status is DONE. Read-only — writes nothing to jobs.
post
Mark a completed JobCodeMatchProcessor process as reset. Writes state.hasReset = true so the frontend can force the matcher UI to reset after the user applies changes, instead of redisplaying the matching table.
get
Return a particular job code by id
delete
Delete a job code
patch
Update an existing job code
job-level
5
get
Find job levels in the organization
post
Create a job level
get
Return a particular job level by id on an effective date
delete
Delete a job level
patch
Update a job level
legalDoc
2
post
Create a legal doc
get
Retrieve the legal doc by name
mcp
4
get
Org-less MCP server SSE stream (not supported)
post
Org-less MCP server message endpoint (JSON-RPC 2.0 over Streamable HTTP)
get
MCP server SSE stream (not supported)
post
MCP server message endpoint (JSON-RPC 2.0 over Streamable HTTP)
media
4
post
Upload a new piece of media
get
Returns metadata about a piece of media
post
Upload a new piece of media
get
Returns metadata about a piece of media
message
7
post
Create a new message
post
Sets each of the designated message's `readAt` property
post
Marks each message as `seen`
get
Return all messages for a particular user
get
Return a particular message by key
get
Return a particular message by id
post
Sets the designated message's `readAt` property
metric
1
post
Record a daily metric
multiplier
5
get
Find comp band multipliers in the organization
post
Create a multiplier
get
Return a particular comp band multiplier by id on an effective date
delete
Delete a multiplier
patch
Update a multiplier
notification
1
post
Send a email or in-app notification
oauth
19
get
Process an Oauth2 redirect request from an access request for an app installation, storing the accessToken and refreshToken as secrets for the app
post
Return a ChartHop authorization token, given a username and password
post
Return a JOIN token to be used for new user operations
post
Return a ChartHop authorization token, given a login token
post
Approve an MCP authorization grant and issue an authorization code
get
Describe a pending MCP authorization grant
get
Retrieve the oauth uri the user should be directed to in order to start the oauth flow
get
Whether the app installation has an active org-level OAuth connection
get
List the per-user OAuth connections for an app installation
delete
Revoke one or more per-user OAuth connections for an app installation
post
Delete the current Oauth2 bearer token (for signout)
post
Send a login ("magic link") email
get
Exchange a one-time use Auth Code for the IDP access token response
get
Login via the auth endpoint
post
Return an Oauth2 Authorization bearer token
delete
Delete the current Oauth2 bearer token (for signout)
post
Given an existing token, issue a new token with a reduced set of scopes
post
Return an Oauth2 Authorization bearer token, given a SSO id token
post
Return a view-as token
org
15
get
Return validation for a org by slug
get
Return all visible orgs, paginated by name
post
Create a new org
post
Validate authorization code
get
Return a particular org by slug
get
Return a particular org by id
patch
Update an existing org
get
Return information on current user's access
post
Consent on Terms of Service agreement
post
Copy self serve demo data into an org
get
Gets the count of joined users, invited users, and org members who are not yet invited
get
Gets a list of org users (joined or invited) and org members (not yet invited)
post
Send a test welcome email to oneself
get
Gets the custom setting or default for the welcome email's subject, body, cta button label
post
Retrieve an Oauth2 authorization code to install an app at this org
org-config
3
get
Return config for a given org
post
Create an org config if it doesn't exist
patch
Update an existing org config
person
11
get
Find persons in the organization
post
Create a person
get
Count persons in an org
get
Count persons in the organization available to invite as users
get
Find persons in the organization, grouped by an expression
get
Find persons in the organization to invite as users
get
Compute top-N + Other subcounts for one or more fields, for persons in the organization
get
Compute aggregated totals for persons matching a query
get
Return a particular person by id
delete
Delete a person
patch
Update a person
policy
9
get
Return all or a set of policies in the organization
post
Create a policy
get
Return all entity:action maps allowed on a policy rule
post
Export policies to CSV format
post
Return if a policy is valid
get
Return a particular policy by id
delete
Delete a policy
patch
Update an existing policy
post
Copy an existing policy
preload
1
get
Return a set of pre-loaded data required by the web app
process
18
get
Retrieve a number of previously run processes
post
Creates a new process in the pending state
get
Get last success sync and last sync for given appUserId
post
Creates a new process in the pending state
post
Creates a new process with a specified createId in the pending state
get
Check the status of a particular process
patch
Update the status of a process, marking its progress or setting status to DONE or ERROR
put
Decrement the step of an asynchronous process
get
Get events associated to a particular process
get
Download the file associated with a particular process
post
Upload a file to be attached to a process, and mark the process as complete
put
Increment the step of an asynchronous process
get
Download the newline-delimited JSON log associated with a particular process
post
Append log messages to a process
post
Replays a process, re-running it from its original inputs; returns the new process
put
Resume an asynchronous process
put
Resume an asynchronous process
put
Update process state
product
5
get
Return all products
post
Create a new product
get
Return all features
get
Return a particular product by id
patch
Update an existing product
profile-tab
10
get
Return all profile tabs in the organization paginated
post
Create a profile tab
get
Return all profile tabs applicable to a particular job
get
Fetch and evaluate the content of a particular profile tab id, relative to a particular job
get
Return all profile tabs applicable to a particular person
get
Fetch and evaluate the content of a particular profile tab id, relative to a particular person
get
Evaluate the history (in the form of various cards) on a particular profile tab id, relative to a particular person
get
Return a particular profile tab by id
delete
Delete a profile tab
patch
Update an existing profile tab
query
5
get
Get a list of query tokens
post
Create a live query token
get
Return the results of a previously created live query
delete
Expire a previously created live query immediately
get
Download an IQY file for a previously created live query
question
5
get
Return all questions in the organization paginated
post
Create a question
get
Return a particular question by id
delete
Delete a question
patch
Update an existing question
report
12
get
Return all reports in the organization paginated
post
Create a report
post
Delete a set of reports
post
Duplicate a set of reports
get
Return count of reports in an organization
post
Return timeseries data from arbitrary queries
get
Return a particular report by id
delete
Delete a report
patch
Update an existing report
post
Export a particular chart in a report
post
Create an exact copy of an existing report
get
Query all the charts in a report
reportChart
7
get
Return a particular report chart by id
delete
Delete a chart from a report
patch
Update an existing report chart
get
Return all of the charts for a particular report
post
Create a new chart in a report
post
Clone a chart in a report
get
Export a particular chart's data
role
7
get
Return all or a set of roles in the organization
post
Create a role
post
Export roles to CSV format
get
Return a particular role by id
delete
Delete a role
patch
Update an existing role
post
Copy an existing role
saml
4
get
Save per org Xml Cert from IDP
post
Save per org Xml Cert from IDP
post
Single sign on URL, where SAML assertion is perform
post
Return an redirect to the designated Idp, given an identity provider
scenario
16
get
Return all scenarios in the organization paginated
post
Create a scenario
post
Archive a set of scenarios
post
Delete a set of scenarios
post
Unarchive a set of scenarios
get
Return a particular scenario by id
delete
Delete a scenario
patch
Update an existing scenario
get
Return past audit log events for a scenario, paginated
post
Combine multiple scenarios into another scenario
post
Adjust the dates of the changes in a scenario
post
Export a scenario's audit log
post
Merge a scenario into the primary timeline
post
Manually recalculate a scenario's metadata
post
Update a scenario view config
post
Upsert multiple scenario view configs in a single atomic request
search
1
get
Return people, job, group, field, goal, and other entity data for a particular org that match a provided search string
signature-request
10
get
Return signature requests
get
Retrieve an individual signature request on an existing file
post
Create a new signature request on a file
get
Retrieve current signature request usage for the organization
get
Retrieve an individual signature request
post
Cancel an existing signature request
post
Decline to sign a signature request
get
Retrieve an individual signature request's signing URL if using an external service
post
Sign a signature request
get
Retrieve all of the signatures relating to a signature request
status
1
get
Returns true if the API is up and available
stock
4
get
Return the history of stock prices
delete
Delete a stock price
get
Get a stock price as of a particular date
put
Upsert a stock price
stockgrant
2
get
Retrieve stock grants
get
Return a particular stock grant by id
stripe
4
get
Return all billing plans directly from Stripe (staff only)
get
Return all products directly from Stripe (staff only)
get
Return a particular product by its Stripe id
post
Creates a Stripe setupIntent object and returns the secret for that object
table
16
get
Return all tables in the organization paginated
post
Create a table
get
Return a particular table by id or name
delete
Delete a table
patch
Update an existing table
get
Retrieve all rows from the table
post
Upsert row data
get
Retrieve a particular row
delete
Delete an existing row
patch
Update an existing row
get
Retrieve the history of a particular row
delete
Delete an existing row, purging from history entirely
post
Export table data to CSV file
post
Import data from CSV file
get
Download a CSV template for a table import
post
Reorder the default order that columns in a table will appear
task
12
get
Return all existing tasks
post
Create a task
delete
Bulk delete tasks
get
Return the tasks for the current user
get
Query tasks for assessments in the organization
post
Send a reminder notification for a particular task
delete
Delete task
delete
Delete task
patch
Update an existing task
patch
Mark task done
post
Reassign an existing task to a different user
patch
Skip task
task-config
4
get
Get all task configs for an org
post
Create a new task config
get
Get a specific task config
patch
Update an existing task config
template
15
get
Return all templates in the organization paginated
post
Create a template
post
Delete a set of templates
post
Duplicate a set of templates
post
Create a template
get
Return a particular email template by name
delete
Delete a template
patch
Update an existing template
get
Return a particular template by id
delete
Delete a template
patch
Update an existing template
get
If the template is a file template, download the file
post
Automatically generate PDFs of the templates, and distribute emails to managers and people to download
post
Preview template content without saving it
post
Render a template by evaluating it against an existing job
Time off ledger
5
post
Create a time off ledger entry
get
Query time off ledger entries in the organization, returning particular time off, job, and person data fields
post
Payroll export of time off ledger
get
Get a time off ledger entry by ID
delete
Delete a time off ledger entry
timeoff
9
get
Retrieve time off requests
post
Create a time off request
post
Request time off
post
Validate a time off request
get
Return a particular time off request by id
delete
Delete a time off request
patch
Update an existing time off request
post
Approve a pending time off request
post
Reject a pending time off request
timeoffAdjustment
5
get
Get all time off balance adjustments for an organization
post
Create a time off balance adjustment
get
Get a specific time off balance adjustment by ID
delete
Delete a time off balance adjustment
patch
Update an existing time off balance adjustment
timeOffPolicy
10
get
Return all policies in the organization
post
Create a time off policy
get
Return time off balances for a given policy and date
get
Return time off balances per policy for a given person
post
Adjust time off balances for a group of people on a given policy and effective date
get
Return a particular time off policy by id
delete
Delete a time off request
patch
Update an existing time off policy
post
Duplicate a time off policy
post
Estimate accrual value for policy
transcript
8
get
Return transcripts in the organization
post
Create a transcript
post
Import transcripts from a JSONL file
post
Import transcripts from a JSONL file already stored (by process file path)
get
Return a particular transcript by id
delete
Delete a transcript
patch
Update a transcript
get
Return the transcript's content as speaker-attributed lines
usage
2
post
Signal interest in upgrading to a paid plan
post
Record usage of a product feature
user
17
get
Return all users within an org or across orgs
post
Create a new user
patch
Assign or remove multiple users a role within an org
get
Count users matching the same filters as findUsers, broken down by invite status
get
Return a particular user by email
post
Create/invite multiple new users
get
Return the login options for a user
get
Return the currently logged in user
get
Return the user the user is currently viewing as
get
Return a particular user by its corresponding person id
post
Send a password reset email
delete
Revoke multiple user's access tokens
get
Return a particular user by id
patch
Update an existing user
post
Change a user's password, or switch a user to SSO
delete
Revoke a user's access token
post
Create/invite multiple new users
webauthn
7
get
List registered credentials for the current user
get
Check for an existing physical key for this user
post
Check for an existing WebAuthn key for this user
delete
Delete registered credentials by the given email
get
Check for an existing physical key for this user
post
Check for an existing physical key for this user
delete
Delete registered credentials by the given credential ID
well-known
6
get
OAuth authorization server metadata (RFC 8414)
get
OAuth authorization server metadata for an org-less agent MCP server (RFC 8414)
get
OAuth authorization server metadata for an agent MCP server (RFC 8414)
get
OAuth protected resource metadata for an org-less agent MCP server (RFC 9728)
get
OAuth protected resource metadata for an agent MCP server (RFC 9728)
get
security.txt (RFC 9116)
well-known
OAuth authorization server metadata (RFC 8414)
get
/.well-known/oauth-authorization-server
Response
successful operation
object
required