# Gem

> Manage recruiting candidates, projects, notes, custom fields and sequences.

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

## Actions

### Add project candidates

Add candidates to a project.

**Inputs**

- Project (`project_id`, text, required): Project id.
- Candidate ids (`candidate_ids`, list, required): Candidate ids.
- User (`app_user_id`, text): User performing the update. If included, the user must have write access to the project.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {}
}
```

### Create candidate

Create a new candidate.

**Inputs**

- Created by (`created_by`, text, required): Created by.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.
- Nickname (`nickname`, text): Nickname.
- Emails (`emails`, list): Emails.
- Linked in handle (`linked_in_handle`, text): If `linked_in_handle` is provided, candidate creation will be de-duplicated. If a candidate with the provided `linked_in_handle` already exists, a 400 error will be returned with `errors` containing information on the existing candidate in this shape: `{"errors": { "duplicate_candidate": { "id": "string", "linked_in_handle": "string" }}}`.
- Title (`title`, text): Title.
- Company (`company`, text): Company.
- Location (`location`, text): Location.
- School (`school`, text): School.
- Education info (`education_info`, list): Education info.
- Work info (`work_info`, list): Work info.
- Profile urls (`profile_urls`, list): If `profile_urls` is provided with an array of urls, social `profiles` will be generated based on the provided urls and attached to the candidate.
- Phone number (`phone_number`, text): Phone number.
- Project ids (`project_ids`, list): If `project_ids` is provided with an array of project ids, the candidate will be added into the projects once they are created.
- Custom fields (`custom_fields`, list): Array of objects containing new custom field values. Only custom fields specified in the array are updated. Click the arrow on the left to find more info about the object.
- Sourced from (`sourced_from`, text): Sourced from. One of: `SeekOut`, `hireEZ`, `Starcircle`, `Censia`, `Consider`, `Cedar`.
- Autofill (`autofill`, true/false): Requires `linked_in_handle` to be non-null. Attempts to fill in any missing fields. Default: `false`.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_greenhouse_id": "example",
    "company": "example",
    "created_at": 1,
    "created_by": "example",
    "custom_fields": [],
    "due_date": {},
    "education_info": [],
    "emails": [],
    "first_name": "example",
    "gem_source": "SeekOut",
    "id": "example",
    "last_name": "example",
    "last_updated_at": 1,
    "linked_in_handle": "example",
    "location": "example",
    "nickname": "example",
    "phone_number": "example",
    "profiles": [],
    "project_ids": [],
    "school": "example",
    "sourced_from": "SeekOut",
    "title": "example",
    "weblink": "example",
    "work_info": []
  }
}
```

### Create candidate event

Create a new candidate event.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- Timestamp (`timestamp`, date and time, required): Timestamp.
- User (`app_user_id`, text, required): User id.
- On behalf of user id (`on_behalf_of_user_id`, text): On behalf of user id.
- Project (`project_id`, text, required): Project id.
- Sequence (`sequence_id`, text, required): Sequence id.
- Type (`type`, text, required): Type. One of: `sequences`, `sequence_replies` (Sequence replies), `manual_touchpoints` (Manual touchpoints).
- Subtype (`subtype`, text, required): Subtype. One of: `first_outreach` (First outreach), `follow_up` (Follow up), `reply`.
- Contact medium (`contact_medium`, text, required): Contact medium. One of: `inmail`, `phone_call` (Phone call), `text_message` (Text message), `email`, `meeting`, `li_connect_request` (Li connect request).
- Reply status (`reply_status`, text): Reply status. One of: `interested`, `not_interested` (Not interested), `later`.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_id": "example",
    "contact_medium": "inmail",
    "id": "example",
    "on_behalf_of_user_id": "example",
    "project_id": "example",
    "reply_status": "interested",
    "sequence_id": "example",
    "subtype": "first_outreach",
    "timestamp": 1,
    "type": "sequences",
    "user_id": "example"
  }
}
```

### Create custom field

Create a new custom field.

**Inputs**

- Name (`name`, text, required): The name of the custom field is unique in its scope. Any leading and trailing spaces of the name string will be removed.
- Value type (`value_type`, text, required): When `value_type` is `text`, `value` is a string. When `value_type` is `date`, `value` is a string of format `yyyy-mm-dd`. When `value_type` is `single_select`, `value` is a string of an option value. When `value_type` is `multi_select`, `value` is an array of strings of option values. One of: `date`, `text`, `single_select` (Single select), `multi_select` (Multi select).
- Scope (`scope`, text, required): Custom fields under `team` scope apply to all candidates. Custom fields under `project` scope apply to candidates in a specific project. One of: `team`, `project`.
- Project (`project_id`, text): Applicable and required when `scope` is `project`. If the custom field has `project` scope, this is the project ID that its associated with.
- Option values (`option_values`, list): Applicable and required when `value_type` is one of (`single_select`, `multi_select`).

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "created_at": 1,
    "id": "example",
    "is_hidden": false,
    "name": "example",
    "options": [],
    "project_id": "example",
    "scope": "team",
    "value_type": "date"
  }
}
```

### Create note

Create a new note.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- User (`app_user_id`, text, required): User id.
- Is private (`is_private`, true/false): Is private. Default: `false`.
- Content (`content`, text, required): Content.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_id": "example",
    "content": "example",
    "id": "example",
    "is_private": false,
    "timestamp": 1,
    "user_id": "example"
  }
}
```

### Create project

Create a new project.

**Inputs**

- User (`app_user_id`, text, required): The user id of the project owner.
- Name (`name`, text, required): Name.
- Privacy type (`privacy_type`, text): Privacy type. One of: `confidential`, `personal`, `shared`. Default: `personal`.
- Description (`description`, text): Description.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "additional_metadata": {
      "splash_event_id": "example"
    },
    "context": "example",
    "created_at": 1,
    "description": "example",
    "id": "example",
    "is_archived": false,
    "name": "example",
    "privacy_type": "confidential",
    "project_fields": [],
    "user_id": "example"
  }
}
```

### Delete candidate

Delete a candidate.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- Permanently remove contact info (`permanently_remove_contact_info`, true/false): Prevent the deleted candidate's contact info from being added back to Gem. Default: `false`.
- On behalf of user id (`on_behalf_of_user_id`, text, required): On behalf of user id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete note

Delete a note by ID.

**Inputs**

- Note id (`note_id`, text, required): Note id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {}
}
```

### Get candidate

Get candidate by ID.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_greenhouse_id": "example",
    "company": "example",
    "created_at": 1,
    "created_by": "example",
    "custom_fields": [],
    "due_date": {},
    "education_info": [],
    "emails": [],
    "first_name": "example",
    "gem_source": "SeekOut",
    "id": "example",
    "last_name": "example",
    "last_updated_at": 1,
    "linked_in_handle": "example",
    "location": "example",
    "nickname": "example",
    "phone_number": "example",
    "profiles": [],
    "project_ids": [],
    "school": "example",
    "sourced_from": "SeekOut",
    "title": "example",
    "weblink": "example",
    "work_info": []
  }
}
```

### Get candidate event

Get event by event ID.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- Event id (`event_id`, text, required): Event id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_id": "example",
    "contact_medium": "inmail",
    "id": "example",
    "on_behalf_of_user_id": "example",
    "project_id": "example",
    "reply_status": "interested",
    "sequence_id": "example",
    "subtype": "first_outreach",
    "timestamp": 1,
    "type": "sequences",
    "user_id": "example"
  }
}
```

### Get custom field

Get custom field by ID.

**Inputs**

- Custom field (`custom_field_id`, text, required): Custom field id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "created_at": 1,
    "id": "example",
    "is_hidden": false,
    "name": "example",
    "options": [],
    "project_id": "example",
    "scope": "team",
    "value_type": "date"
  }
}
```

### Get note

Get note by note ID.

**Inputs**

- Note id (`note_id`, text, required): Note id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_id": "example",
    "content": "example",
    "id": "example",
    "is_private": false,
    "timestamp": 1,
    "user_id": "example"
  }
}
```

### Get project

Get project by ID.

**Inputs**

- Project (`project_id`, text, required): Project id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "additional_metadata": {
      "splash_event_id": "example"
    },
    "context": "example",
    "created_at": 1,
    "description": "example",
    "id": "example",
    "is_archived": false,
    "name": "example",
    "privacy_type": "confidential",
    "project_fields": [],
    "user_id": "example"
  }
}
```

### Get sequence

Get sequence by ID.

**Inputs**

- Sequence (`sequence_id`, text, required): Sequence id.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "created_at": 1,
    "id": "example",
    "name": "example",
    "user_id": "example"
  }
}
```

### List candidate notes

List notes that belong to a candidate.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List candidates

List candidates.

**Inputs**

- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- Created by (`created_by`, text): the id of the user who adds the candidate into Gem
- Email (`email`, text): If `email` is provided, the candidates whose email addresses contain `email` will be returned.
- Linked in handle (`linked_in_handle`, text): Linked in handle.
- Updated after (`updated_after`, date and time): If `updated_after` is provided, only the candidates updated after the provided timestamp will be returned. Please provide a Unix timestamp in seconds.
- Updated before (`updated_before`, date and time): If `updated_before` is provided, only the candidates updated before the provided timestamp will be returned. Please provide a Unix timestamp in seconds.
- Candidate ids (`candidate_ids`, list): If `candidate_ids` is provided, only the candidates with a provided ID will be returned. Please provide a comma-separated string. e.g.: `candidate_ids=123,456,789`. A maximum of 20 candidate_ids can be provided.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List custom fields

List custom fields.

**Inputs**

- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- Project (`project_id`, text): Only applicable when `scope` is `project`.
- Scope (`scope`, text): Custom fields under `team` scope apply to all candidates. Custom fields under `project` scope apply to candidates in a specific project. One of: `team`, `project`.
- Is hidden (`is_hidden`, true/false): `hidden` custom fields in the candidate info are not displayed in the Gem product or not returned when making a query on the Candidates endpoint.
- Name (`name`, text): Any leading and trailing spaces of the name string will be removed.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List project candidates

List candidates in a project.

**Inputs**

- Project (`project_id`, text, required): Project id.
- Added after (`added_after`, date and time): Added after.
- Added before (`added_before`, date and time): Added before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List projects

List projects.

**Inputs**

- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- User (`app_user_id`, text): List all projects owned by this user.
- Readable by (`readable_by`, text): List all projects that this user has read access to.
- Writable by (`writable_by`, text): List all projects that this user has write access to, that is, all the projects that this user can add/remove candidates
- Is archived (`is_archived`, true/false): Is archived.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List sequences

List sequences.

**Inputs**

- Created after (`created_after`, date and time): Created after.
- Created before (`created_before`, date and time): Created before.
- Sort (`sort`, text): Sort. One of: `asc`, `desc`.
- User (`app_user_id`, text): User id.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### List users

List users.

**Inputs**

- Email (`email`, text): Email.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Page size (`page_size`, number): Page size. From 1 to 100. Default: `20`.

**Outputs**

- `data` (list): Gem response data.

**Example output**

```json
{
  "data": []
}
```

### Remove project candidates

Remove candidates from a project.

**Inputs**

- Project (`project_id`, text, required): Project id.
- Candidate ids (`candidate_ids`, list, required): Candidate ids.
- User (`app_user_id`, text): User performing the update. If included, the user must have write access to the project.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {}
}
```

### Update candidate

Modify a candidate.

**Inputs**

- Candidate id (`candidate_id`, text, required): Candidate id.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.
- Nickname (`nickname`, text): Nickname.
- Emails (`emails`, list): Emails.
- Title (`title`, text): Title.
- Company (`company`, text): Company.
- Location (`location`, text): Location.
- School (`school`, text): School.
- Profile urls (`profile_urls`, list): If `profile_urls` is provided with an array of urls, social `profiles` will be replaced with new profiles based on the provided urls.
- Phone number (`phone_number`, text): Phone number.
- Due date (`due_date`, object): Due date.
- Custom fields (`custom_fields`, list): Array of objects containing custom field values to be updated for the candidate. Only custom fields specified in the array are updated. Click the arrow on the left to find more info about the object.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "candidate_greenhouse_id": "example",
    "company": "example",
    "created_at": 1,
    "created_by": "example",
    "custom_fields": [],
    "due_date": {},
    "education_info": [],
    "emails": [],
    "first_name": "example",
    "gem_source": "SeekOut",
    "id": "example",
    "last_name": "example",
    "last_updated_at": 1,
    "linked_in_handle": "example",
    "location": "example",
    "nickname": "example",
    "phone_number": "example",
    "profiles": [],
    "project_ids": [],
    "school": "example",
    "sourced_from": "SeekOut",
    "title": "example",
    "weblink": "example",
    "work_info": []
  }
}
```

### Update custom field

Modify a custom field.

**Inputs**

- Custom field (`custom_field_id`, text, required): Custom field id.
- Name (`name`, text): The name of the custom field is unique in its scope. Any leading and trailing spaces of the name string will be removed.
- Is hidden (`is_hidden`, true/false): `hidden` custom fields in the candidate info are not displayed in the Gem product or not returned when making a query on the Candidates endpoint.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "created_at": 1,
    "id": "example",
    "is_hidden": false,
    "name": "example",
    "options": [],
    "project_id": "example",
    "scope": "team",
    "value_type": "date"
  }
}
```

### Update project

Modify a project.

**Inputs**

- Project (`project_id`, text, required): Project id.
- User (`app_user_id`, text): The user id of the project owner.
- Name (`name`, text): Name.
- Privacy type (`privacy_type`, text): Privacy type. One of: `confidential`, `personal`, `shared`.
- Description (`description`, text): Description.
- Is archived (`is_archived`, true/false): Is archived.

**Outputs**

- `data` (object): Gem response data.

**Example output**

```json
{
  "data": {
    "additional_metadata": {
      "splash_event_id": "example"
    },
    "context": "example",
    "created_at": 1,
    "description": "example",
    "id": "example",
    "is_archived": false,
    "name": "example",
    "privacy_type": "confidential",
    "project_fields": [],
    "user_id": "example"
  }
}
```
