Leapsome Goals API
The goals API from Leapsome — 6 operation(s) for goals.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/leapsome-goals-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.1
title: Leapsome Goals API
contact:
name: Support
url: https://leapsome.zendesk.com
description: The Content API enables you to export some raw data from Leapsome for usage within your own systems and beyond what the Leapsome application offers natively. Usage is restricted to a maximum of 20 requests per second when making requests in parallel. If you exceed this limit, you will receive a 429 status code.
servers:
- url: https://api.leapsome.com/v1
tags:
- name: Goals
paths:
/goals:
get:
summary: List goals
description: 'Setting multiple filters will result in a subset of goals that satisfy *all* constraints.
All filters except for `search` accept comma-separated values.'
operationId: listGoals
security:
- bearerAuth: []
tags:
- Goals
parameters:
- name: userId
in: query
required: false
description: select goals containing *any* of the userIds.
explode: false
schema:
type: array
items:
type: string
pattern: ^[0-9a-f]{24}$
example: 58d55e3ffdc2eb20547edd0a
- name: teamId
in: query
required: false
description: select goals containing *any* of the teamIds.
explode: false
schema:
type: array
items:
type: string
pattern: ^[0-9a-f]{24}$
example: 58d55e3ffdc2eb20547edd0a
- name: tagId
in: query
required: false
description: select goals containing *all* of the tagIds.
explode: false
schema:
type: array
items:
type: string
pattern: ^[0-9a-f]{24}$
example: 58d55e3ffdc2eb20547edd0a
- name: type
in: query
required: false
description: select goals that match by `type` to *any* of the types listed.
explode: false
schema:
type: array
items:
type: string
enum:
- company
- team
- user
- name: search
in: query
required: false
description: 'search on title, user name and team name fields. Special symbols must be URL-encoded.
Search is performed on a whole value of a text field, without splitting it into words
(e.g. search for `ark` will match `Marketing`).
'
schema:
type: string
- name: state
in: query
description: only include goals that match provided state
explode: false
schema:
type: array
items:
type: string
enum:
- live
- draft
- archived
- $ref: '#/components/parameters/limitParam'
- $ref: '#/components/parameters/cursorParam'
responses:
'200':
description: A paginated array of user goals
headers:
X-Next:
$ref: '#/components/headers/X-Next'
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedGoals'
examples:
example-1:
value:
meta:
count: 1
cursor: 58d55e3ffdc2eb20547edd0a
nextPage: string
data:
- id: 5b237f6868794d5c08555812
type: user
user:
id: 58d55e3ffdc2eb20547edd0a
email: example@example.com
fullName: John Doe
preferredName: John Doe
team:
id: 5b237f6868794d5c08555812
name: Rocket Scientists
name: Become a great place to work (d)
description: Make it entertaining
contributors:
- id: 58d55e3ffdc2eb20547edd0a
email: example@example.com
fullName: John Doe
preferredName: John Doe
progress: 50
status: live
managedBy:
id: 58d55e3ffdc2eb20547edd0a
email: example@example.com
fullName: John Doe
preferredName: John Doe
tags:
- id: 5b237f6868794d5c08555812
name: string
deadline: '2019-08-24T14:15:22Z'
keyResults:
- id: 5b237f6868794d5c08555812
name: Bring Glassdoor score up above 4
metric:
type: currency
start: 0
end: 1000
current: 650
weight: 30
ownerUser:
id: 58d55e3ffdc2eb20547edd0a
email: example@example.com
fullName: John Doe
preferredName: John Doe
ownerTeam:
id: 5b237f6868794d5c08555812
name: Engineer
parent:
_id: 5cb0855f0f089e6924b742e4
name: Enhance Employee Experience and Retention
status: live
progressStatus: onTrack
createdAt: '2019-08-23T11:53:06.741Z'
updatedAt: '2019-08-23T11:53:06.741Z'
/goals/tags:
get:
summary: get list of goal tags
operationId: listTags
security:
- bearerAuth: []
tags:
- Goals
responses:
'200':
description: An array of goal tags
content:
application/json:
schema:
$ref: '#/components/schemas/Tags'
/goals/{goalId}:
get:
summary: Get goal details
operationId: getGoalDetails
parameters:
- in: path
name: goalId
required: true
schema:
type: string
pattern: ^[0-9a-f]{24}$
description: ID of the goal
security:
- bearerAuth: []
tags:
- Goals
responses:
'200':
description: Goal details
content:
application/json:
schema:
$ref: '#/components/schemas/Goal'
/goals/{goalId}/comments:
get:
summary: get list of comments for a goal
operationId: listGoalComments
parameters:
- in: path
name: goalId
required: true
schema:
type: string
description: ID of the goal
security:
- bearerAuth: []
tags:
- Goals
responses:
'200':
description: An array of goal comments ordered by creation date (descending)
content:
application/json:
schema:
$ref: '#/components/schemas/Comments'
/goals/{goalId}/key-results/{keyResultId}:
post:
summary: Update key result
operationId: updateKeyResult
parameters:
- in: path
name: goalId
required: true
schema:
type: string
pattern: ^[0-9a-f]{24}$
description: ID of the goal
- in: path
name: keyResultId
required: true
schema:
type: string
pattern: ^[0-9a-f]{24}$
description: ID of the key result
security:
- bearerAuth: []
tags:
- Goals
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/KeyResultUpdate'
responses:
'200':
description: Updated goal
content:
application/json:
schema:
$ref: '#/components/schemas/Goal'
/goals/{goalId}/initiatives/{initiativeId}:
post:
summary: Update initiative
operationId: updateInitiative
parameters:
- in: path
name: goalId
required: true
schema:
type: string
pattern: ^[0-9a-f]{24}$
description: ID of the goal
- in: path
name: initiativeId
required: true
schema:
type: string
pattern: ^[0-9a-f]{24}$
description: ID of the initiative
security:
- bearerAuth: []
tags:
- Goals
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InitiativeUpdate'
responses:
'200':
description: Updated goal
content:
application/json:
schema:
$ref: '#/components/schemas/Goal'
components:
schemas:
Comments:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/Comment'
Meta:
type: object
required:
- count
- cursor
- nextPage
properties:
count:
type: integer
description: number of results returned in this request
minimum: 1
maximum: 1000
cursor:
type:
- string
- 'null'
description: 'Will be set to `null` if complete set have been returned.
'
pattern: ^[0-9a-f]{24}$
example: 58d55e3ffdc2eb20547edd0a
nextPage:
type:
- string
- 'null'
format: url
description: URL of the next result page. `null` means no more results available.
Goal:
type: object
required:
- id
- type
- name
- description
- contributors
- progress
- status
- managedBy
- tags
- deadline
- keyResults
- parent
- createdAt
- updatedAt
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
type:
type: string
enum:
- user
- team
- company
example: user
user:
allOf:
- $ref: '#/components/schemas/User'
- description: 'Information about the user, who''s assigned to this goal.
Will be `null` for Team and Company goals.
'
team:
type:
- object
- 'null'
description: 'Information about the team, that''s assigned to this goal.
Will be `null` for User and Company goals.
'
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
example: Rocket Scientists
name:
type: string
example: Become a great place to work (d)
description:
type: string
example: Make it entertaining
contributors:
type: array
items:
$ref: '#/components/schemas/User'
progress:
type: integer
minimum: 0
maximum: 100
example: 50
status:
type: string
enum:
- archived
- live
- draft
- removed
example: live
managedBy:
$ref: '#/components/schemas/User'
tags:
type: array
items:
type: object
required:
- id
- name
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
deadline:
type:
- string
- 'null'
format: date-time
keyResults:
type: array
items:
$ref: '#/components/schemas/KeyResults'
parent:
$ref: '#/components/schemas/ParentGoal'
progressStatus:
type:
- string
- 'null'
enum:
- onTrack
- offTrack
- inputNeeded
- done
- canceled
createdAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
updatedAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
KeyResults:
type: object
required:
- id
- name
- metric
- weight
- ownerTeam
- ownerUser
- contributors
- contributorTeams
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
example: Bring Glassdoor score up above 4
metric:
type: object
required:
- type
- start
- end
- current
properties:
type:
type: string
example: currency
enum:
- none
- numerical
- percentage
- currency
start:
type: integer
end:
type: integer
current:
type: integer
weight:
type: integer
minimum: 0
maximum: 100
example: 30
ownerUser:
$ref: '#/components/schemas/User'
ownerTeam:
type: object
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
example: Engineer
contributors:
type: array
items:
$ref: '#/components/schemas/User'
contributorTeams:
type: array
items:
type: object
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
example: Engineer
Tag:
type: object
required:
- id
- name
- status
- createdAt
- updatedAt
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5b237f6868794d5c08555812
name:
type: string
example: Marketing
status:
type: string
enum:
- active
- viewOnly
- removed
createdAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
updatedAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
ParentGoal:
type:
- object
- 'null'
properties:
_id:
type: string
pattern: ^[0-9a-f]{24}$
example: 5cb0855f0f089e6924b742e4
name:
type: string
example: Enhance Employee Experience and Retention
status:
type: string
enum:
- live
- draft
- archived
example: live
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
User:
type: object
required:
- id
- email
- fullName
properties:
id:
type: string
pattern: ^[0-9a-f]{24}$
example: 58d55e3ffdc2eb20547edd0a
email:
type: string
format: email
example: example@example.com
fullName:
type: string
example: John Doe
preferredName:
type: string
example: John von Doe (Full name)
PaginatedGoals:
type: object
properties:
meta:
$ref: '#/components/schemas/Meta'
data:
type: array
items:
$ref: '#/components/schemas/Goal'
Comment:
type: object
required:
- id
- content
- sender
- createdAt
- updatedAt
properties:
id:
type: string
content:
type: string
description: The comment body which can contain html tags
sender:
type: object
required:
- id
- firstname
- lastname
- picture
properties:
id:
type: string
firstname:
type: string
lastname:
type: string
picture:
type: string
format: url
createdAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
updatedAt:
type: string
format: date-time
example: '2019-08-23T11:53:06.741Z'
KeyResultUpdate:
type: object
properties:
name:
type: string
example: Bring Glassdoor score up above 4
metric:
type: object
required:
- type
- start
- end
- current
properties:
type:
type: string
enum:
- none
- numerical
- percentage
- currency
start:
type: integer
end:
type: integer
current:
type: integer
weight:
type: integer
minimum: 0
maximum: 100
InitiativeUpdate:
type: object
properties:
name:
type: string
description:
type: string
status:
type: string
enum:
- notStarted
- inProgress
- completed
- blocked
parameters:
limitParam:
name: limit
in: query
description: Maximal number of results in a response
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
cursorParam:
name: cursor
in: query
required: false
description: 'Start showing results from this location. Typically, you do not
need to set this parameter manually, it is mainly used in
"x-next" header
'
schema:
type: string
pattern: ^[0-9a-f]{24}$
headers:
X-Next:
description: A link to the next page of responses
schema:
type: string
format: url
example: https://api.leapsome.com/v1/goals?cursor=58d55e3ffdc2eb20547edd0a&limit=100
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT