# Lattice

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/lattice

## Actions

### Add goal progress

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

**Inputs**

- Goal progress (`id`, text, required): Id.
- Comment (`comment`, text, required): Comment about the goal progress
- Status (`status`, text, required): Status of the goal. One of: `green`, `amber`, `red`.
- Increment (`increment`, number): Relative increment to add to the goal's current progress. Mutually exclusive with absolute ; exactly one must be provided.
- Absolute (`absolute`, number): Absolute value to set the goal's progress to. Mutually exclusive with increment ; exactly one must be provided.
- Complete (`complete`, true/false): Whether the goal is complete. Default: `false`.
- Incomplete (`incomplete`, true/false): Whether the goal is incomplete. Default: `false`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The name of the goal
- Description (`description`, text): Detailed description of the goal
- Start date (`start_date`, date, required): Start date for the goal
- Due date (`due_date`, date, required): Due date for the goal
- Priority (`priority`, number): Priority level (1-10). From 1 to 10.
- Private (`private`, true/false): Whether the goal is private. Default: `false`.
- Owner IDs (`owner_ids`, list, required): User owner(s) of the goal. One minimum is required.
- Okr type (`okr_type`, text, required): OKR type, objective or key result. One of: `objective`, `key_result` (Key result).
- Amount type (`amount_type`, text): The progress amount type for okrType = key results. One of: `percent`, `dollar`, `digit`, `binary`.
- Starting amount (`starting_amount`, number): Starting amount for key results. Required when goal type is key result and amountType is not binary
- Goal amount (`goal_amount`, number): Target amount for key results. Required when goal type is key result and amountType is not binary
- Company goal (`company_goal`, true/false): Whether this is a company goal. Default: `false`.
- Department (`department_id`, text): Department entity ID
- Departments visible to IDs (`departments_visible_to_ids`, list): Array of department entity IDs that can view this goal
- Goal cycle ID (`goal_cycle_id`, text): Goal cycle entity ID
- Tag names (`tag_names`, list): Array of tag names (max 5 tags)
- Is draft (`is_draft`, true/false): Whether to save as draft. Default: `false`.
- Parent ID (`parent_id`, text): Parent goal entity ID

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Goal (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 cycle (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 ID (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- User (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "pageInfo": {
      "endCursor": "example",
      "hasNextPage": false,
      "startCursor": "example"
    }
  }
}
```

### List cycle reviewees

List the people being reviewed in a Lattice review cycle.

**Inputs**

- Cycle reviewees (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List cycle reviews

List the reviews written in a Lattice review cycle.

**Inputs**

- Cycle reviews (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- Order direction (`order_direction`, text): Order directions. One of: `asc`, `desc`.
- Offset (`offset`, number): Offset.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List departments

List the departments in your Lattice account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 reports (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List feedback

List the feedback people have sent each other in Lattice.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- Only public (`only_public`, true/false): Only public.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List goal updates

List the progress updates posted on one goal in Lattice.

**Inputs**

- Goal updates (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "pageInfo": {
      "endCursor": "example",
      "hasNextPage": false,
      "startCursor": "example"
    }
  }
}
```

### List goals

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

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- State (`state`, text): State. One of: `Draft`, `Active`, `Ended`, `Archived`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List review cycles

List the performance review cycles in your Lattice account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- Recurring review cycle rule ID (`recurring_review_cycle_rule_id`, text): Recurring review cycle rule id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List reviewee reviews

List the reviews written about one person in Lattice.

**Inputs**

- Reviewee reviews ID (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List updates

List the company updates posted in Lattice.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 attributes (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List user goals

List the goals owned by one person in Lattice.

**Inputs**

- User goals (`id`, text, required): Id.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- State (`state`, text): State. One of: `Draft`, `Active`, `Ended`, `Archived`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```

### List user tasks

List the tasks assigned to one person in Lattice.

**Inputs**

- User tasks (`id`, text, required): Id.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Starting after (`starting_after`, text): Starting after.
- Status (`status`, text): A lifecycle status for a user or null. One of: `ACTIVE`, `INVITED`, `CREATED`, `DEACTIVATED`, `NULL`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "endingCursor": "example",
    "hasMore": false,
    "object": "list"
  }
}
```
