Lattice

App · 25 actions

Read people, feedback, goals, tasks and reviews; create goals and post progress updates in Lattice.

Actions

ActionWhat it does
Add goal progressPost a progress update on a Lattice goal, with a new progress value and a note.
Create goalCreate a new goal in Lattice and assign it an owner.
Get current userGet the Lattice user the connection is signed in as, including their name, email and role.
Get departmentGet one department in Lattice by its ID, with its name and members.
Get feedbackGet one piece of feedback in Lattice by its ID, with who sent it and who it is for.
Get goalGet one goal in Lattice by its ID, including its owner, status and progress.
Get review cycleGet one review cycle in Lattice by its ID, with its dates and status.
Get revieweeGet one person's review record in Lattice by its ID.
Get updateGet one company update in Lattice by its ID.
Get userGet one person in Lattice by their ID, including their name, email, department and manager.
List all goal updatesList the progress updates posted on every goal in Lattice.
List cycle revieweesList the people being reviewed in a Lattice review cycle.
List cycle reviewsList the reviews written in a Lattice review cycle.
List departmentsList the departments in your Lattice account.
List direct reportsList the people who report directly to a given person in Lattice.
List feedbackList the feedback people have sent each other in Lattice.
List goal updatesList the progress updates posted on one goal in Lattice.
List goalsList the goals in your Lattice account, with their owners and progress.
List review cyclesList the performance review cycles in your Lattice account.
List reviewee reviewsList the reviews written about one person in Lattice.
List updatesList the company updates posted in Lattice.
List user attributesList the custom attributes set on a person in Lattice, such as location or cost center.
List user goalsList the goals owned by one person in Lattice.
List user tasksList the tasks assigned to one person in Lattice.
List usersList the people in your Lattice account, with their name, email, department and manager.

Add goal progress

Post a progress update on a Lattice goal, with a new progress value and a note.

Inputs

Goal progressidtextRequired
Id.
CommentcommenttextRequired
Comment about the goal progress
StatusstatustextRequired
Status of the goalOne of: green, amber, red.
Incrementincrementnumber
Relative increment to add to the goal's current progress. Mutually exclusive with absolute ; exactly one must be provided.
Absoluteabsolutenumber
Absolute value to set the goal's progress to. Mutually exclusive with increment ; exactly one must be provided.
Completecompletetrue/false
Whether the goal is completeDefault: false.
Incompleteincompletetrue/false
Whether the goal is incompleteDefault: false.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": {
      "comment": "example",
      "entityId": "example",
      "goalId": 1.0,
      "id": 1.0,
      "increment": "example",
      "status": "green"
    }
  }
}

Create goal

Create a new goal in Lattice and assign it an owner.

Inputs

NamenametextRequired
The name of the goal
Descriptiondescriptiontext
Detailed description of the goal
Start datestart_datedateRequired
Start date for the goal
Due datedue_datedateRequired
Due date for the goal
Priorityprioritynumber
Priority level (1-10)From 1 to 10.
Privateprivatetrue/false
Whether the goal is privateDefault: false.
Owner IDsowner_idslistRequired
User owner(s) of the goal. One minimum is required.
Okr typeokr_typetextRequired
OKR type, objective or key resultOne of: objective, key_result (Key result).
Amount typeamount_typetext
The progress amount type for okrType = key results.One of: percent, dollar, digit, binary.
Starting amountstarting_amountnumber
Starting amount for key results. Required when goal type is key result and amountType is not binary
Goal amountgoal_amountnumber
Target amount for key results. Required when goal type is key result and amountType is not binary
Company goalcompany_goaltrue/false
Whether this is a company goalDefault: false.
Departmentdepartment_idtext
Department entity ID
Departments visible to IDsdepartments_visible_to_idslist
Array of department entity IDs that can view this goal
Goal cycle IDgoal_cycle_idtext
Goal cycle entity ID
Tag namestag_nameslist
Array of tag names (max 5 tags)
Is draftis_drafttrue/false
Whether to save as draftDefault: false.
Parent IDparent_idtext
Parent goal entity ID

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": {
      "amountType": "percent",
      "companyGoal": false,
      "departmentId": "example",
      "description": "example",
      "dueDate": "example",
      "entityId": "example",
      "goalAmount": 1.0,
      "goalCycleId": "example",
      "isDraft": false,
      "name": "example",
      "okrType": "objective",
      "ownerIds": [],
      "parentId": "example",
      "priority": 1.0,
      "private": false,
      "startDate": "example",
      "startingAmount": 1.0,
      "tags": []
    }
  }
}

Get current user

Get the Lattice user the connection is signed in as, including their name, email and role.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "birthDate": "example",
    "createdAt": 1,
    "customAttributes": {
      "object": "example",
      "url": "example"
    },
    "department": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "directReports": {
      "object": "example",
      "url": "example"
    },
    "email": "example",
    "externalUserId": "example",
    "gender": "Female",
    "id": "example",
    "isAdmin": false,
    "jobFunction": "example",
    "jobLevel": "example",
    "jobType": "example",
    "manager": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "name": "example",
    "object": "example",
    "preferredName": "example",
    "startDate": "example",
    "status": "ACTIVE",
    "tasks": {
      "object": "example",
      "url": "example"
    },
    "timezone": "example",
    "title": "example",
    "updatedAt": 1,
    "url": "example"
  }
}

Get department

Get one department in Lattice by its ID, with its name and members.

Inputs

Department IDidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": 1,
    "description": "example",
    "id": "example",
    "name": "example",
    "object": "example",
    "url": "example"
  }
}

Get feedback

Get one piece of feedback in Lattice by its ID, with who sent it and who it is for.

Inputs

Feedback IDidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "associatedValues": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "author": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "body": "example",
    "competency": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "createdAt": 1,
    "feedbackRequest": {
      "author": {
        "id": "example",
        "object": "example",
        "url": "example"
      },
      "body": "example",
      "competency": {
        "id": "example",
        "object": "example",
        "url": "example"
      },
      "createdAt": 1,
      "fulfilledAt": 1,
      "object": "example",
      "subject": {
        "id": "example",
        "object": "example",
        "url": "example"
      },
      "target": {
        "id": "example",
        "object": "example",
        "url": "example"
      }
    },
    "id": "example",
    "isPublic": false,
    "object": "example",
    "targets": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "url": "example",
    "visibility": "example"
  }
}

Get goal

Get one goal in Lattice by its ID, including its owner, status and progress.

Inputs

GoalidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "amountType": "Percent",
    "archivedAt": 1,
    "childGoals": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "completedAt": 1,
    "createdAt": 1,
    "currentAmount": 1.0,
    "department": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "description": "example",
    "dueDate": "example",
    "endingAmount": 1.0,
    "goalType": "Company",
    "id": "example",
    "isPrivate": false,
    "lastUpdatedAt": 1,
    "name": "example",
    "object": "example",
    "okrType": "objective",
    "owners": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "parentGoal": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "priority": 1,
    "publishedAt": 1,
    "startDate": "example",
    "startingAmount": 1.0,
    "state": "Draft",
    "status": "NotUpdated",
    "tags": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "updatedAt": 1,
    "url": "example"
  }
}

Get review cycle

Get one review cycle in Lattice by its ID, with its dates and status.

Inputs

Review cycleidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "autocalculatedWeightedScoresEnabled": false,
    "calibrationEnabled": false,
    "calibrationEndedAt": 1,
    "createdAt": 1,
    "creator": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "id": "example",
    "name": "example",
    "object": "example",
    "peerSelectionStartedAt": 1,
    "recurringReviewCycleRule": {
      "id": "example",
      "name": "example"
    },
    "reviewees": {
      "object": "example",
      "url": "example"
    },
    "reviews": {
      "object": "example",
      "url": "example"
    },
    "reviewsEndedAt": 1,
    "reviewsStartedAt": 1,
    "stage": "Draft",
    "updatedAt": 1,
    "url": "example",
    "weightedScoresEnabled": false,
    "weightedScoresEndedAt": 1
  }
}

Get reviewee

Get one person's review record in Lattice by its ID.

Inputs

Reviewee IDidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "closedAt": 1,
    "createdAt": 1,
    "esignatureGivenAt": 1,
    "externalUserId": "example",
    "id": "example",
    "managerFacingPDFUrl": "example",
    "object": "example",
    "responsesReleasedAt": 1,
    "reviewCycle": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "revieweeFacingPDFUrl": "example",
    "reviews": {
      "object": "example",
      "url": "example"
    },
    "updatedAt": 1,
    "url": "example",
    "user": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "weightedScore": {
      "autoCalculated": 1.0,
      "manual": 1.0
    }
  }
}

Get update

Get one company update in Lattice by its ID.

Inputs

Update IDidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "author": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "createdAt": 1,
    "id": "example",
    "isPublic": false,
    "manager": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "object": "example",
    "publishedAt": 1,
    "responses": {
      "data": [],
      "endingCursor": "example",
      "hasMore": false,
      "object": "example"
    },
    "reviewedAt": 1,
    "sentiment": {
      "id": "example",
      "object": "example",
      "rating": 1
    },
    "url": "example"
  }
}

Get user

Get one person in Lattice by their ID, including their name, email, department and manager.

Inputs

UseridtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "birthDate": "example",
    "createdAt": 1,
    "customAttributes": {
      "object": "example",
      "url": "example"
    },
    "department": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "directReports": {
      "object": "example",
      "url": "example"
    },
    "email": "example",
    "externalUserId": "example",
    "gender": "Female",
    "id": "example",
    "isAdmin": false,
    "jobFunction": "example",
    "jobLevel": "example",
    "jobType": "example",
    "manager": {
      "id": "example",
      "object": "example",
      "url": "example"
    },
    "name": "example",
    "object": "example",
    "preferredName": "example",
    "startDate": "example",
    "status": "ACTIVE",
    "tasks": {
      "object": "example",
      "url": "example"
    },
    "timezone": "example",
    "title": "example",
    "updatedAt": 1,
    "url": "example"
  }
}

List all goal updates

List the progress updates posted on every goal in Lattice.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "pageInfo": {
      "endCursor": "example",
      "hasNextPage": false,
      "startCursor": "example"
    }
  }
}

List cycle reviewees

List the people being reviewed in a Lattice review cycle.

Inputs

Cycle revieweesidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List cycle reviews

List the reviews written in a Lattice review cycle.

Inputs

Cycle reviewsidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Order directionorder_directiontext
Order directionsOne of: asc, desc.
Offsetoffsetnumber
Offset.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List departments

List the departments in your Lattice account.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List direct reports

List the people who report directly to a given person in Lattice.

Inputs

Direct reportsidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List feedback

List the feedback people have sent each other in Lattice.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Only publiconly_publictrue/false
Only public.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List goal updates

List the progress updates posted on one goal in Lattice.

Inputs

Goal updatesidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "pageInfo": {
      "endCursor": "example",
      "hasNextPage": false,
      "startCursor": "example"
    }
  }
}

List goals

List the goals in your Lattice account, with their owners and progress.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Statestatetext
State.One of: Draft, Active, Ended, Archived.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List review cycles

List the performance review cycles in your Lattice account.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Recurring review cycle rule IDrecurring_review_cycle_rule_idtext
Recurring review cycle rule id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List reviewee reviews

List the reviews written about one person in Lattice.

Inputs

Reviewee reviews IDidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List updates

List the company updates posted in Lattice.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List user attributes

List the custom attributes set on a person in Lattice, such as location or cost center.

Inputs

User attributesidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List user goals

List the goals owned by one person in Lattice.

Inputs

User goalsidtextRequired
Id.
Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Statestatetext
State.One of: Draft, Active, Ended, Archived.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List user tasks

List the tasks assigned to one person in Lattice.

Inputs

User tasksidtextRequired
Id.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

List users

List the people in your Lattice account, with their name, email, department and manager.

Inputs

Limitlimitnumber
Limit.From 1 to 100. Default: 100.
Starting afterstarting_aftertext
Starting after.
Statusstatustext
A lifecycle status for a user or nullOne of: ACTIVE, INVITED, CREATED, DEACTIVATED, NULL.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}

On this page