Leapsome
App · 23 actions
Work with Leapsome's goals, reviews and people: check in on key results, read review cycles and results, look up people, absences, timesheets and payroll, give praise and feedback, add documents to profiles, and start a workflow when a goal, praise, review, person or absence changes.
Actions
| Action | What it does |
|---|---|
| Add document to profile | Add a file, up to 25 MB, to a person's documents in Leapsome, filed under a category, such as a signed contract or a past review. |
| Get goal | Get one goal with its key results and their values, owners, contributors, tags, deadline and progress. |
| Get person | Get one person's profile: email, manager, teams, title, level, work location, start date and custom attributes. |
| Get review cycle | Get one review cycle with its questions and its timeline of deadlines for peer, manager and conversation steps. |
| Get reviewee results | Get every reviewer's ratings and comments about one person in a review cycle, with each question's average. |
| Give instant feedback | Give one person feedback in Leapsome, sent as the person you choose. |
| Give praise | Praise one or more people in Leapsome, sent as the person you choose. |
| List absences | List absences such as vacation and sick leave, by the date they start, status and person. |
| List document categories | List the categories documents on people's profiles are filed under. |
| List goal comments | List the comments on a goal, newest first, with who wrote each. |
| List goal tags | List the tags goals can carry, with their ids. |
| List goals | List goals with their key results, owners and progress, by person, team, tag, type or state. |
| List job history | List each change to people's positions (title, employment type, base pay) with the dates it applied. |
| List payroll cycle participants | List the people paid in a payroll cycle with their salary and compensations, such as bonuses. |
| List payroll cycles | List payroll cycles with their pay periods, status and approval. |
| List people | List the people in Leapsome with their managers, teams, title, start date and attributes, by email, name or status. |
| List praise and feedback | List praise and instant feedback with who sent it, who got it, the message and its likes, by type, sender or receiver. |
| List review cycles | List performance review cycles by status, name or template, with when each started and was last changed. |
| List review participants | List who is reviewed in a cycle, with each reviewer (managers, peers, direct reports), how far they've got and the average rating. |
| List timesheets | List timesheets with hours worked, overtime, projects and approval status. |
| List work locations | List offices and other work locations with their addresses. |
| Update key result | Check in on a goal's key result: set its current value, or change its measure, target, name or weight. |
| Write private note | Write a note about someone that only its sender can see, such as something to bring up at their next review. |
Add document to profile
Add a file, up to 25 MB, to a person's documents in Leapsome, filed under a category, such as a signed contract or a past review.
Inputs
- Person
employee_idtextRequired - Whose profile to add it to.
- Category
category_idtextRequired - The category to file it under.
- File
filetextRequired - The file: upload one, pick one from an earlier step, or give a public link.
- Description
descriptiontext - A short note on what the document is.
Outputs
document_idtext- The id of the new document
Example output
{
"document_id": "6553a1b2c3d4e5f601234572"
}Get goal
Get one goal with its key results and their values, owners, contributors, tags, deadline and progress.
Inputs
- Goal
goal_idtextRequired - The goal. Pick one, or give its id from an earlier step.
Outputs
goalobject- The goal
Example output
{
"goal": {
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"createdAt": "2026-08-23T11:53:06.741Z",
"deadline": "2026-12-31T23:59:59.000Z",
"description": "Make it entertaining",
"id": "5b237f6868794d5c08555815",
"keyResults": [
{
"contributorTeams": [
{
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
}
],
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"id": "5b237f6868794d5c08555813",
"metric": {
"current": 650,
"end": 1000,
"start": 0,
"type": "numerical"
},
"name": "Bring Glassdoor score up above 4",
"ownerTeam": {
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
},
"ownerUser": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"weight": 30
}
],
"managedBy": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"name": "Become a great place to work",
"parent": {
"_id": "5cb0855f0f089e6924b742e4",
"name": "Enhance Employee Experience and Retention",
"status": "live"
},
"progress": 65,
"progressStatus": "onTrack",
"status": "live",
"tags": [
{
"id": "5b237f6868794d5c08555816",
"name": "Culture"
}
],
"team": {
"id": "5b237f6868794d5c08555812",
"name": "Rocket Scientists"
},
"type": "user",
"updatedAt": "2026-11-02T09:12:44.120Z",
"user": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
}
}Get person
Get one person's profile: email, manager, teams, title, level, work location, start date and custom attributes.
Inputs
- Person
employee_idtextRequired - The person to get.
Outputs
employeeobject- The person
Example output
{
"employee": {
"additionalManagers": [
{
"id": "58d625f5fdc2eb20547ede85",
"name": "Jack Johnson"
}
],
"address": {
"addition": "Apt. 4B",
"city": "Berlin",
"country": "Germany",
"postcode": "10115",
"state": "Berlin",
"street": "123 Main Street"
},
"birthday": "1990-05-17T00:00:00.000Z",
"businessUnits": [
{
"id": "58d55e3ffdc2eb20547edd0d",
"name": "Business Unit Green"
}
],
"compensation": {
"currency": "EUR",
"frequency": "year",
"salary": 75000
},
"costCenters": [
{
"id": "58d55e3ffdc2eb20547edd0e",
"name": "Cost Center Yellow"
}
],
"customAttributes": {
"T-shirt size": "M"
},
"departments": [
{
"id": "58d55e3ffdc2eb20547edd0c",
"name": "Research"
}
],
"displayedName": "Jane Doe",
"divisions": [
{
"id": "58d55e3ffdc2eb20547edd0f",
"name": "Division Purple"
}
],
"email": "jane.doe@example.com",
"employeeId": "EMP-00123",
"employmentType": "internalFullTime",
"endDate": "2027-12-31T23:59:59.999Z",
"firstname": "Jane",
"fullname": "Jane Doe",
"gender": "female",
"id": "58d55e3ffdc2eb20547edd0a",
"indirectManagers": [
{
"id": "58d625f5fdc2eb20547ede86",
"name": "Mary Major"
}
],
"lastname": "Doe",
"level": "Senior",
"lifecycleStatus": "active",
"manager": {
"id": "58d55e3ffdc2eb20547edd00",
"name": "Peter Pan"
},
"middlename": "",
"otherGroups": [
{
"id": "58d55e3ffdc2eb20547edd10",
"name": "Other Group Orange"
}
],
"phone": "+4930123456",
"startDate": "2024-01-01T00:00:00.000Z",
"status": "active",
"teams": [
{
"id": "5b237f6868794d5c08555812",
"name": "Rocket Scientists"
}
],
"title": "Software Engineer",
"workLocation": {
"id": "58d55e3ffdc2eb20547edd11",
"name": "Berlin Office"
}
}
}Get review cycle
Get one review cycle with its questions and its timeline of deadlines for peer, manager and conversation steps.
Inputs
- Review cycle
review_cycle_idtextRequired - The review cycle. Pick one, or give its id from an earlier step.
Outputs
review_cycleobject- The review cycle
Example output
{
"review_cycle": {
"_id": "5a869af092cf001f4ce73c26",
"createdAt": "2026-02-16T08:48:48.363Z",
"name": "Performance Review Q2",
"questions": [
{
"_id": "58d55e55fdc2eb20547edd16",
"name": "Delivers results"
},
{
"_id": "58d55e55fdc2eb20547edd0f",
"name": "Takes ownership"
}
],
"status": "complete",
"timeline": {
"conversationsDeadline": "2026-05-07T08:46:11.444Z",
"managerReviewsDeadline": "2026-04-27T08:46:11.444Z",
"peerApprovalDeadline": "1970-01-01T00:00:00.000Z",
"peerNominationsDeadline": "1970-01-01T00:00:00.000Z",
"peerReviewsDeadline": "2026-04-13T08:46:11.444Z",
"start": "2026-03-02T08:46:11.444Z"
}
}
}Get reviewee results
Get every reviewer's ratings and comments about one person in a review cycle, with each question's average. Needs an API key whose access roles can see review answers.
Inputs
- Review cycle
review_cycle_idtextRequired - The review cycle. Pick one, or give its id from an earlier step.
- Reviewee
employee_idtextRequired - The person reviewed in that cycle.
Outputs
answerslist- Each reviewer's answer to each question
questionslist- Each question, with its average score out of 100
userslist- The people who wrote or received the answers
Example output
{
"answers": [
{
"authorId": "62ac40b5f1f4baf9a1b6fb52",
"comment": "Great job!",
"multipleChoice": "A",
"question": "58d55e55fdc2eb20547edd16",
"rating": 6,
"receiverId": "58d625f5fdc2eb20547ede84",
"scale": 6,
"type": "Peer Review"
}
],
"questions": [
{
"_id": "58d55e55fdc2eb20547edd16",
"average": 100,
"name": "Delivers results"
}
],
"users": [
{
"_id": "58d625f5fdc2eb20547ede84",
"email": "susanne@example.com",
"fullName": "Susanne Leader",
"location": "London",
"preferredName": "Susanne Leader",
"teams": "Managers (Auto), Sales"
}
]
}Give instant feedback
Give one person feedback in Leapsome, sent as the person you choose. Only the receiver sees it unless you choose otherwise.
Inputs
- From
sender_idtextRequired - Who it comes from. Leapsome shows it as sent by this person.
- To
receiver_idtextRequired - Who the feedback is for.
- Message
messagetextRequired - What to say.
- Who can see it
visibilitytext - Defaults to only the receiver.One of:
receiver(Only the receiver (default)),manager(The receiver and their manager),public(Everyone),senderOnly(Only the sender).
Outputs
feedback_idtext- The id of the new feedback item
Example output
{
"feedback_id": "6553a1b2c3d4e5f601234570"
}Give praise
Praise one or more people in Leapsome, sent as the person you choose. Everyone sees it unless you keep it to those praised.
Inputs
- From
sender_idtextRequired - Who it comes from. Leapsome shows it as sent by this person.
- To
receiver_idslistRequired - The people to praise.
- Message
messagetextRequired - What to say.
- Who can see it
visibilitytext - Everyone, or only the people praised. Defaults to everyone.One of:
public(Everyone (default)),receiver(Only the people praised).
Outputs
feedback_idtext- The id of the new feedback item
Example output
{
"feedback_id": "6553a1b2c3d4e5f601234567"
}List absences
List absences such as vacation and sick leave, by the date they start, status and person. Needs an API key that can manage absences. Gets one page.
Inputs
- Starting on or after
starts_fromdate - Only absences that start on or after this day.
- Starting on or before
starts_untildate - Only absences that start on or before this day.
- Status
statustext - Only absences with this status.One of:
active,pendingRemoval(Pending removal),removed. - Person
employee_idtext - Only this person's absences. Leave empty for everyone.
- Page
pagenumber - Which page to get, starting at 1. Leave empty for the first.At least 1.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
absenceslist- The absences
countnumber- How many in this set
pagenumber- The page this set is
Example output
{
"absences": [
{
"_id": "66a1b2c3d4e5f6789012345a",
"absenceType": "paidVacation",
"activityType": "nonWorkingPaid",
"actualAbsenceDuration": 4,
"comment": "Winter break",
"createdAt": "2026-11-15T08:30:00.000Z",
"end": "2026-12-24T23:59:59.999Z",
"endDayDuration": "fullDay",
"endDayTime": "17:00",
"start": "2026-12-21T00:00:00.000Z",
"startDayDuration": "fullDay",
"startDayTime": "09:00",
"status": "active",
"timeUnit": "days",
"updatedAt": "2026-11-15T08:30:00.000Z",
"userId": "58d55e3ffdc2eb20547edd0a"
}
],
"count": 1,
"page": 1
}List document categories
List the categories documents on people's profiles are filed under.
Inputs
None.
Outputs
categorieslist- The categories
countnumber- How many in this set
Example output
{
"categories": [
{
"id": "58d55e3ffdc2eb20547edd12",
"name": "Past Reviews"
}
],
"count": 1
}List goal comments
List the comments on a goal, newest first, with who wrote each.
Inputs
- Goal
goal_idtextRequired - The goal. Pick one, or give its id from an earlier step.
Outputs
commentslist- The comments
countnumber- How many in this set
Example output
{
"comments": [
{
"content": "<p>Great progress this month!</p>",
"createdAt": "2026-11-02T09:12:44.120Z",
"id": "64a1f0c2e4b0a1b2c3d4e5f6",
"sender": {
"firstname": "John",
"id": "58d55e3ffdc2eb20547edd0a",
"lastname": "Doe",
"picture": "https://www.leapsome.com/img/avatar.png"
},
"updatedAt": "2026-11-02T09:12:44.120Z"
}
],
"count": 1
}List goal tags
List the tags goals can carry, with their ids.
Inputs
None.
Outputs
countnumber- How many in this set
tagslist- The goal tags
Example output
{
"count": 1,
"tags": [
{
"createdAt": "2026-01-10T08:00:00.000Z",
"id": "5b237f6868794d5c08555816",
"name": "Culture",
"status": "active",
"updatedAt": "2026-01-10T08:00:00.000Z"
}
]
}List goals
List goals with their key results, owners and progress, by person, team, tag, type or state. Gets one set; to see more, run it again with the cursor it gives.
Inputs
- People
user_idslist - Only ones that include any of these people as owner or contributor.
- Teams
team_idslist - Only ones that include any of these teams.
- Tags
tag_idslist - Only goals that have all of these tags.
- Goal types
goal_typeslist - Only company, team or individual goals.One or more of:
company(Company goals),team(Team goals),user(Individual goals). - States
stateslist - Only live, draft or archived goals.One or more of:
live,draft,archived. - Search
searchtext - Text to find in the goal's title or its owner's or team's name, matching inside words (ark finds Marketing).
- Limit
limitnumber - How many to return, up to 1000. Leapsome's default is 100.From 1 to 1000.
- Next page cursor
cursortext - The 'next_cursor' from an earlier run, with the same filters, to get the set after it.
Outputs
countnumber- How many in this set
goalslist- The goals
next_cursortext- Pass as 'Next page cursor' for the next set; empty on the last
Example output
{
"count": 1,
"goals": [
{
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"createdAt": "2026-08-23T11:53:06.741Z",
"deadline": "2026-12-31T23:59:59.000Z",
"description": "Make it entertaining",
"id": "5b237f6868794d5c08555815",
"keyResults": [
{
"contributorTeams": [
{
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
}
],
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"id": "5b237f6868794d5c08555813",
"metric": {
"current": 650,
"end": 1000,
"start": 0,
"type": "numerical"
},
"name": "Bring Glassdoor score up above 4",
"ownerTeam": {
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
},
"ownerUser": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"weight": 30
}
],
"managedBy": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"name": "Become a great place to work",
"parent": {
"_id": "5cb0855f0f089e6924b742e4",
"name": "Enhance Employee Experience and Retention",
"status": "live"
},
"progress": 65,
"progressStatus": "onTrack",
"status": "live",
"tags": [
{
"id": "5b237f6868794d5c08555816",
"name": "Culture"
}
],
"team": {
"id": "5b237f6868794d5c08555812",
"name": "Rocket Scientists"
},
"type": "user",
"updatedAt": "2026-11-02T09:12:44.120Z",
"user": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
}
],
"next_cursor": ""
}List job history
List each change to people's positions (title, employment type, base pay) with the dates it applied. Gets one page.
Inputs
- Person
employee_idtext - Only this person's history. Leave empty for everyone.
- Order
ordertext - By the date each change took effect. Defaults to newest first.One of:
-effectiveAt(Newest first),effectiveAt(Oldest first). - Page
pagenumber - Which page to get, starting at 1. Leave empty for the first.At least 1.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
employmentslist- The position records
pagenumber- The page this set is
total_countnumber- How many there are in all
Example output
{
"count": 1,
"employments": [
{
"compensation": {
"currency": "eur",
"frequency": "year",
"salary": 85000
},
"createdAt": "2024-01-02T09:00:00.000Z",
"effectiveAt": "2024-01-01T00:00:00.000Z",
"effectiveUntil": "2025-06-01T00:00:00.000Z",
"employee": "58d55e3ffdc2eb20547edd0a",
"employmentType": "internalFullTime",
"flsaCode": "exempt",
"id": "58d55e3ffdc2eb20547edd0a-2024-01-01T00:00:00.000Z",
"title": "Senior Software Engineer",
"updatedAt": "2024-01-02T09:00:00.000Z"
}
],
"page": 1,
"total_count": 1
}List payroll cycle participants
List the people paid in a payroll cycle with their salary and compensations, such as bonuses.
Inputs
- Payroll cycle
payroll_cycle_idtextRequired - The payroll cycle. Pick one, or give its id from an earlier step.
- Person
employee_idtext - Only this person. Leave empty for everyone.
- Skip
offsetnumber - How many to skip, for the next set: the 'next_offset' from an earlier run. Leave empty to start at the beginning.At least 0.
- Limit
limitnumber - How many to return, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
next_offsetnumber- Pass as 'Skip' for the next set; 0 on the last
participantslist- The people paid
total_countnumber- How many there are in all
Example output
{
"count": 1,
"next_offset": 0,
"participants": [
{
"compensations": [
{
"amount": 5000,
"amountType": "fixed",
"comment": "Performance bonus",
"effectiveAt": "2026-01-01T00:00:00.000Z",
"name": "Annual Bonus",
"recurrence": "every12Months",
"validUntil": "2026-12-31T23:59:59.999Z"
}
],
"email": "jane.doe@example.com",
"id": "6553a1b2c3d4e5f60123456b",
"isActiveParticipant": true,
"name": "Jane Doe",
"salaryInfoPeriods": [
{
"baseSalary": 75000,
"compensationType": "fixed",
"currency": "EUR",
"salary": 6250,
"salaryRemunerationPeriod": "month"
}
]
}
],
"total_count": 1
}List payroll cycles
List payroll cycles with their pay periods, status and approval. Needs an API key that can manage payroll.
Inputs
- Name
nametext - Only cycles whose name contains this text.
- Status
statustext - Only cycles with this status.One of:
draft,active,completed,archived. - Skip
offsetnumber - How many to skip, for the next set: the 'next_offset' from an earlier run. Leave empty to start at the beginning.At least 0.
- Limit
limitnumber - How many to return, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
next_offsetnumber- Pass as 'Skip' for the next set; 0 on the last
payroll_cycleslist- The payroll cycles
total_countnumber- How many there are in all
Example output
{
"count": 1,
"next_offset": 0,
"payroll_cycles": [
{
"approvalStartAt": "2026-11-27T00:00:00.000Z",
"approvedAt": "2026-11-28T10:00:00.000Z",
"approvedBy": "58d55e3ffdc2eb20547edd00",
"compensations": {
"baseSalaryCustomName": "Base salary"
},
"createdAt": "2026-10-20T09:00:00.000Z",
"customPeriodEndAt": "2026-11-24T23:59:59.999Z",
"customPeriodStartAt": "2026-10-25T00:00:00.000Z",
"endAt": "2026-11-30T23:59:59.999Z",
"id": "6553a1b2c3d4e5f60123456a",
"name": "November 2026 Payroll",
"prorateType": "actualNumberOfMonthDays",
"reviewStartAt": "2026-11-25T00:00:00.000Z",
"startAt": "2026-11-01T00:00:00.000Z",
"status": "open",
"updatedAt": "2026-11-02T09:00:00.000Z"
}
],
"total_count": 1
}List people
List the people in Leapsome with their managers, teams, title, start date and attributes, by email, name or status. Gets one page. Which attributes show depends on the API key's access roles.
Inputs
- Email
emailtext - Only the person with this email address.
- Name
nametext - Only people whose name contains this text.
- Status
statustext - Only people with this status. Leave empty for everyone.One of:
active,invited,created(Created, not invited yet),preBoardingInvited(Pre-boarding, invited),preBoardingActive(Pre-boarding, active),deactivated,removed. - Page
pagenumber - Which page to get, starting at 1. Leave empty for the first.At least 1.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
employeeslist- The people
pagenumber- The page this set is
total_countnumber- How many there are in all
Example output
{
"count": 1,
"employees": [
{
"additionalManagers": [
{
"id": "58d625f5fdc2eb20547ede85",
"name": "Jack Johnson"
}
],
"address": {
"addition": "Apt. 4B",
"city": "Berlin",
"country": "Germany",
"postcode": "10115",
"state": "Berlin",
"street": "123 Main Street"
},
"birthday": "1990-05-17T00:00:00.000Z",
"businessUnits": [
{
"id": "58d55e3ffdc2eb20547edd0d",
"name": "Business Unit Green"
}
],
"compensation": {
"currency": "EUR",
"frequency": "year",
"salary": 75000
},
"costCenters": [
{
"id": "58d55e3ffdc2eb20547edd0e",
"name": "Cost Center Yellow"
}
],
"customAttributes": {
"T-shirt size": "M"
},
"departments": [
{
"id": "58d55e3ffdc2eb20547edd0c",
"name": "Research"
}
],
"displayedName": "Jane Doe",
"divisions": [
{
"id": "58d55e3ffdc2eb20547edd0f",
"name": "Division Purple"
}
],
"email": "jane.doe@example.com",
"employeeId": "EMP-00123",
"employmentType": "internalFullTime",
"endDate": "2027-12-31T23:59:59.999Z",
"firstname": "Jane",
"fullname": "Jane Doe",
"gender": "female",
"id": "58d55e3ffdc2eb20547edd0a",
"indirectManagers": [
{
"id": "58d625f5fdc2eb20547ede86",
"name": "Mary Major"
}
],
"lastname": "Doe",
"level": "Senior",
"lifecycleStatus": "active",
"manager": {
"id": "58d55e3ffdc2eb20547edd00",
"name": "Peter Pan"
},
"middlename": "",
"otherGroups": [
{
"id": "58d55e3ffdc2eb20547edd10",
"name": "Other Group Orange"
}
],
"phone": "+4930123456",
"startDate": "2024-01-01T00:00:00.000Z",
"status": "active",
"teams": [
{
"id": "5b237f6868794d5c08555812",
"name": "Rocket Scientists"
}
],
"title": "Software Engineer",
"workLocation": {
"id": "58d55e3ffdc2eb20547edd11",
"name": "Berlin Office"
}
}
],
"page": 1,
"total_count": 1
}List praise and feedback
List praise and instant feedback with who sent it, who got it, the message and its likes, by type, sender or receiver.
Inputs
- Type
feedback_typetext - Only praise or only instant feedback. Leave empty for both.One of:
praise,instantFeedback(Instant feedback). - Received by
receiver_idtext - Only what this person received.
- Sent by
sender_idtext - Only what this person sent.
- Skip
offsetnumber - How many to skip, for the next set: the 'next_offset' from an earlier run. Leave empty to start at the beginning.At least 0.
- Limit
limitnumber - How many to return, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
feedbacklist- The praise and feedback
next_offsetnumber- Pass as 'Skip' for the next set; 0 on the last
total_countnumber- How many there are in all
Example output
{
"count": 1,
"feedback": [
{
"badge": {
"icon": "/img/badges/team-player.svg",
"name": "Team player"
},
"commentsCount": 1,
"createdAt": "2026-11-16T14:05:00.000Z",
"id": "6553a1b2c3d4e5f601234567",
"likesCount": 4,
"message": "Thanks for running the onboarding week so smoothly!",
"receivers": [
{
"id": "58d55e3ffdc2eb20547edd0a",
"name": "Jane Doe"
}
],
"sender": {
"id": "58d55e3ffdc2eb20547edd00",
"name": "Peter Pan"
},
"type": "praise",
"visibility": "public"
}
],
"next_offset": 0,
"total_count": 1
}List review cycles
List performance review cycles by status, name or template, with when each started and was last changed. Gets one page.
Inputs
- Status
status_filtertext - Which cycles to include. Leave empty for all.One of:
all(All cycles),draft(Drafts),upcoming(Not launched yet),ongoing,complete(Completed). - Name
nametext - Only cycles whose name contains this text.
- Template name
template_nametext - Only cycles made from a template whose name contains this text.
- Order
sorttext - Newest created or latest kickoff first.One of:
creationDate(Newest created first),kickoffDate(Latest kickoff first). - Conversation deadline after
conversation_deadline_afterdate and time - Only cycles whose review conversations are due after this.
- Changed after
last_modified_afterdate and time - Only cycles where anyone's review changed after this.
- Page
pagenumber - Which page to get, starting at 0. Leave empty for the first.At least 0.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 20.From 1 to 1000.
Outputs
countnumber- How many in this set
has_moretrue/false- True when the page was full, so the next page may have more
pagenumber- The page this set is
review_cycleslist- The review cycles
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"review_cycles": [
{
"_id": "5a869af092cf001f4ce73c26",
"createdAt": "2026-02-16T08:48:48.363Z",
"kickoffDate": "2026-02-18T08:48:48.363Z",
"lastModifiedOn": "2026-02-20T10:15:30.000Z",
"name": "Performance Review Q1 2026",
"status": "peerReviewsPending",
"template": "63e42f779f7f18396a38f54d"
}
]
}List review participants
List who is reviewed in a cycle, with each reviewer (managers, peers, direct reports), how far they've got and the average rating. Gets one page.
Inputs
- Review cycle
review_cycle_idtextRequired - The review cycle. Pick one, or give its id from an earlier step.
- Page
pagenumber - Which page to get, starting at 0. Leave empty for the first.At least 0.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 20.From 1 to 1000.
Outputs
countnumber- How many in this set
has_moretrue/false- True when the page was full, so the next page may have more
pagenumber- The page this set is
participantslist- The people reviewed
Example output
{
"count": 1,
"has_more": false,
"page": 0,
"participants": [
{
"_id": "58d55e3ffdc2eb20547edd0b",
"additionalManagers": [
{
"averageRating": "0 / 100",
"lastModifiedBy": "58d625f5fdc2eb20547ede85",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"name": "Jack Johnson",
"preferredName": "Jack Johnson",
"status": "pending",
"user": "58d625f5fdc2eb20547ede85"
}
],
"directReports": [
{
"averageRating": "75 / 100",
"lastModifiedBy": "62ab64e3339234d9c4a527f1",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"name": "Sandra Susie",
"preferredName": "Sandra Susie",
"status": "complete",
"user": "62ab64e3339234d9c4a527f1"
}
],
"lastModifiedBy": "58d55e3ffdc2eb20547edd0a",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"managers": [
{
"averageRating": "50 / 100",
"lastModifiedBy": "58d55e3ffdc2eb20547edd00",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"name": "Peter Pan",
"preferredName": "Peter Pan",
"status": "complete",
"user": "58d55e3ffdc2eb20547edd00"
}
],
"peers": [
{
"averageRating": "75 / 100",
"lastModifiedBy": "62ab64e3339234d9c4a527f2",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"name": "Jason Minor",
"preferredName": "Jason Minor",
"status": "complete",
"user": "62ab64e3339234d9c4a527f2"
}
],
"reviewee": {
"averageRating": "80 / 100",
"lastModifiedBy": "58d55e3ffdc2eb20547edd0a",
"lastModifiedOn": "2026-03-04T13:15:11.574+00:00",
"name": "Louise Leapsome",
"preferredName": "Louise Leapsome",
"status": "complete",
"user": "58d55e3ffdc2eb20547edd0a"
},
"signatureManager": "2026-03-04T13:15:11.574+00:00",
"signatureReviewee": "2026-03-04T13:15:11.574+00:00"
}
]
}List timesheets
List timesheets with hours worked, overtime, projects and approval status. Needs an API key that can manage time tracking.
Inputs
- Person
employee_idtext - Only this person's timesheets. Leave empty for everyone.
- Skip
offsetnumber - How many to skip, for the next set: the 'next_offset' from an earlier run. Leave empty to start at the beginning.At least 0.
- Limit
limitnumber - How many to return, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
next_offsetnumber- Pass as 'Skip' for the next set; 0 on the last
timesheetslist- The timesheets
total_countnumber- How many there are in all
Example output
{
"count": 1,
"next_offset": 0,
"timesheets": [
{
"compensableHours": "PT80H",
"endDate": "2026-11-30T23:59:59.999Z",
"hoursWorked": "PT82H",
"id": "6553a1b2c3d4e5f601234568",
"overtimeHours": "PT2H",
"projects": [
{
"id": "6553a1b2c3d4e5f601234569",
"title": "Website relaunch"
}
],
"startDate": "2026-11-01T00:00:00.000Z",
"status": "open",
"user": {
"email": "jane.doe@example.com",
"id": "58d55e3ffdc2eb20547edd0a",
"name": "Jane Doe"
},
"workDuration": "PT82H"
}
],
"total_count": 1
}List work locations
List offices and other work locations with their addresses.
Inputs
- Name
nametext - Only locations whose name contains this text.
- Status
statustext - Only active or only inactive locations.One of:
active,inactive. - Page
pagenumber - Which page to get, starting at 1. Leave empty for the first.At least 1.
- Page size
page_sizenumber - How many to return per page, up to 1000. Leapsome's default is 100.From 1 to 1000.
Outputs
countnumber- How many in this set
pagenumber- The page this set is
total_countnumber- How many there are in all
work_locationslist- The work locations
Example output
{
"count": 1,
"page": 1,
"total_count": 1,
"work_locations": [
{
"administrativeDivision": "Berlin",
"city": "Berlin",
"country": "Germany",
"createdAt": "2024-01-15T08:30:00.000Z",
"currency": "EUR",
"dateFormat": "DD.MM.YYYY",
"id": "58d55e3ffdc2eb20547edd11",
"name": "Berlin Office",
"primary": true,
"remote": false,
"status": "active",
"street": "123 Main Street",
"updatedAt": "2024-01-20T10:15:00.000Z",
"zip": "10115"
}
]
}Update key result
Check in on a goal's key result: set its current value, or change its measure, target, name or weight. Only the fields given change, and the goal's progress follows.
Inputs
- Goal
goal_idtextRequired - The goal. Pick one, or give its id from an earlier step.
- Key result
key_result_idtextRequired - The key result to update. Pick a goal first.
- Current value
current_valuenumber - Where the key result stands now, such as 650.
- Target value
target_valuenumber - The value that means done. Leave empty to keep it.
- Start value
start_valuenumber - The value it started from. Leave empty to keep it.
- Measure
metric_typetext - How it is measured. Leave empty to keep it.One of:
numerical(Number),percentage,currency,none(No measure (done or not done)). - Name
nametext - A new name for the key result. Leave empty to keep it.
- Weight
weightnumber - How much it counts towards the goal, 0 to 100.From 0 to 100.
Outputs
goalobject- The goal, as it is after the change
key_resultobject- The key result, as changed
Example output
{
"goal": {
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"createdAt": "2026-08-23T11:53:06.741Z",
"deadline": "2026-12-31T23:59:59.000Z",
"description": "Make it entertaining",
"id": "5b237f6868794d5c08555815",
"keyResults": [
{
"contributorTeams": [
{
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
}
],
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"id": "5b237f6868794d5c08555813",
"metric": {
"current": 650,
"end": 1000,
"start": 0,
"type": "numerical"
},
"name": "Bring Glassdoor score up above 4",
"ownerTeam": {
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
},
"ownerUser": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"weight": 30
}
],
"managedBy": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"name": "Become a great place to work",
"parent": {
"_id": "5cb0855f0f089e6924b742e4",
"name": "Enhance Employee Experience and Retention",
"status": "live"
},
"progress": 65,
"progressStatus": "onTrack",
"status": "live",
"tags": [
{
"id": "5b237f6868794d5c08555816",
"name": "Culture"
}
],
"team": {
"id": "5b237f6868794d5c08555812",
"name": "Rocket Scientists"
},
"type": "user",
"updatedAt": "2026-11-02T09:12:44.120Z",
"user": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
},
"key_result": {
"contributorTeams": [
{
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
}
],
"contributors": [
{
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
}
],
"id": "5b237f6868794d5c08555813",
"metric": {
"current": 650,
"end": 1000,
"start": 0,
"type": "numerical"
},
"name": "Bring Glassdoor score up above 4",
"ownerTeam": {
"id": "5b237f6868794d5c08555814",
"name": "Engineering"
},
"ownerUser": {
"email": "john.doe@example.com",
"fullName": "John Doe",
"id": "58d55e3ffdc2eb20547edd0a",
"preferredName": "John Doe"
},
"weight": 30
}
}Write private note
Write a note about someone that only its sender can see, such as something to bring up at their next review.
Inputs
- Written by
sender_idtextRequired - Whose note it is. Only this person can see it.
- About
receiver_idtextRequired - Who the note is about.
- Message
messagetextRequired - What to say.
Outputs
feedback_idtext- The id of the new feedback item
Example output
{
"feedback_id": "6553a1b2c3d4e5f601234571"
}