Gem
App · 25 actions
Manage recruiting candidates, projects, notes, custom fields and sequences.
Actions
| Action | What it does |
|---|---|
| Add project candidates | Add candidates to a project. |
| Create candidate | Create a new candidate. |
| Create candidate event | Create a new candidate event. |
| Create custom field | Create a new custom field. |
| Create note | Create a new note. |
| Create project | Create a new project. |
| Delete candidate | Delete a candidate. |
| Delete note | Delete a note by ID. |
| Get candidate | Get candidate by ID. |
| Get candidate event | Get event by event ID. |
| Get custom field | Get custom field by ID. |
| Get note | Get note by note ID. |
| Get project | Get project by ID. |
| Get sequence | Get sequence by ID. |
| List candidate notes | List notes that belong to a candidate. |
| List candidates | List candidates. |
| List custom fields | List custom fields. |
| List project candidates | List candidates in a project. |
| List projects | List projects. |
| List sequences | List sequences. |
| List users | List users. |
| Remove project candidates | Remove candidates from a project. |
| Update candidate | Modify a candidate. |
| Update custom field | Modify a custom field. |
| Update project | Modify a project. |
Add project candidates
Add candidates to a project.
Inputs
- Project
project_idtextRequired - Project id.
- Candidate ids
candidate_idslistRequired - Candidate ids.
- User
app_user_idtext - User performing the update. If included, the user must have write access to the project.
Outputs
dataobject- Gem response data.
Example output
{
"data": {}
}Create candidate
Create a new candidate.
Inputs
- Created by
created_bytextRequired - Created by.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Nickname
nicknametext - Nickname.
- Emails
emailslist - Emails.
- Linked in handle
linked_in_handletext - 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
titletext - Title.
- Company
companytext - Company.
- Location
locationtext - Location.
- School
schooltext - School.
- Education info
education_infolist - Education info.
- Work info
work_infolist - Work info.
- Profile urls
profile_urlslist - 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_numbertext - Phone number.
- Project ids
project_idslist - 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_fieldslist - 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_fromtext - Sourced from.One of:
SeekOut,hireEZ,Starcircle,Censia,Consider,Cedar. - Autofill
autofilltrue/false - Requires `linked_in_handle` to be non-null. Attempts to fill in any missing fields.Default:
false.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Candidate id.
- Timestamp
timestampdate and timeRequired - Timestamp.
- User
app_user_idtextRequired - User id.
- On behalf of user id
on_behalf_of_user_idtext - On behalf of user id.
- Project
project_idtextRequired - Project id.
- Sequence
sequence_idtextRequired - Sequence id.
- Type
typetextRequired - Type.One of:
sequences,sequence_replies(Sequence replies),manual_touchpoints(Manual touchpoints). - Subtype
subtypetextRequired - Subtype.One of:
first_outreach(First outreach),follow_up(Follow up),reply. - Contact medium
contact_mediumtextRequired - Contact medium.One of:
inmail,phone_call(Phone call),text_message(Text message),email,meeting,li_connect_request(Li connect request). - Reply status
reply_statustext - Reply status.One of:
interested,not_interested(Not interested),later.
Outputs
dataobject- Gem response data.
Example output
{
"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
nametextRequired - 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_typetextRequired - 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
scopetextRequired - 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_idtext - 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_valueslist - Applicable and required when `value_type` is one of (`single_select`, `multi_select`).
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Candidate id.
- User
app_user_idtextRequired - User id.
- Is private
is_privatetrue/false - Is private.Default:
false. - Content
contenttextRequired - Content.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - The user id of the project owner.
- Name
nametextRequired - Name.
- Privacy type
privacy_typetext - Privacy type.One of:
confidential,personal,shared. Default:personal. - Description
descriptiontext - Description.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Candidate id.
- Permanently remove contact info
permanently_remove_contact_infotrue/false - Prevent the deleted candidate's contact info from being added back to GemDefault:
false. - On behalf of user id
on_behalf_of_user_idtextRequired - On behalf of user id.
Outputs
dataobject- Gem response data.
Example output
{
"data": {}
}Delete note
Delete a note by ID.
Inputs
- Note id
note_idtextRequired - Note id.
Outputs
dataobject- Gem response data.
Example output
{
"data": {}
}Get candidate
Get candidate by ID.
Inputs
- Candidate id
candidate_idtextRequired - Candidate id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Candidate id.
- Event id
event_idtextRequired - Event id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Custom field id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Note id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Project id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Sequence id.
Outputs
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Candidate id.
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Sort
sorttext - Sort.One of:
asc,desc. - Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List candidates
List candidates.
Inputs
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Sort
sorttext - Sort.One of:
asc,desc. - Created by
created_bytext - the id of the user who adds the candidate into Gem
- Email
emailtext - If `email` is provided, the candidates whose email addresses contain `email` will be returned.
- Linked in handle
linked_in_handletext - Linked in handle.
- Updated after
updated_afterdate 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_beforedate 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_idslist - 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
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List custom fields
List custom fields.
Inputs
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Sort
sorttext - Sort.One of:
asc,desc. - Project
project_idtext - Only applicable when `scope` is `project`.
- Scope
scopetext - 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_hiddentrue/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
nametext - Any leading and trailing spaces of the name string will be removed.
- Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List project candidates
List candidates in a project.
Inputs
- Project
project_idtextRequired - Project id.
- Added after
added_afterdate and time - Added after.
- Added before
added_beforedate and time - Added before.
- Sort
sorttext - Sort.One of:
asc,desc. - Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List projects
List projects.
Inputs
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Sort
sorttext - Sort.One of:
asc,desc. - User
app_user_idtext - List all projects owned by this user.
- Readable by
readable_bytext - List all projects that this user has read access to.
- Writable by
writable_bytext - 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_archivedtrue/false - Is archived.
- Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List sequences
List sequences.
Inputs
- Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Sort
sorttext - Sort.One of:
asc,desc. - User
app_user_idtext - User id.
- Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}List users
List users.
Inputs
- Email
emailtext - Email.
- Page
pagenumber - Page.At least 1. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
20.
Outputs
datalist- Gem response data.
Example output
{
"data": []
}Remove project candidates
Remove candidates from a project.
Inputs
- Project
project_idtextRequired - Project id.
- Candidate ids
candidate_idslistRequired - Candidate ids.
- User
app_user_idtext - User performing the update. If included, the user must have write access to the project.
Outputs
dataobject- Gem response data.
Example output
{
"data": {}
}Update candidate
Modify a candidate.
Inputs
- Candidate id
candidate_idtextRequired - Candidate id.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Nickname
nicknametext - Nickname.
- Emails
emailslist - Emails.
- Title
titletext - Title.
- Company
companytext - Company.
- Location
locationtext - Location.
- School
schooltext - School.
- Profile urls
profile_urlslist - 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_numbertext - Phone number.
- Due date
due_dateobject - Due date.
- Custom fields
custom_fieldslist - 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
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Custom field id.
- Name
nametext - 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_hiddentrue/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
dataobject- Gem response data.
Example output
{
"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_idtextRequired - Project id.
- User
app_user_idtext - The user id of the project owner.
- Name
nametext - Name.
- Privacy type
privacy_typetext - Privacy type.One of:
confidential,personal,shared. - Description
descriptiontext - Description.
- Is archived
is_archivedtrue/false - Is archived.
Outputs
dataobject- Gem response data.
Example output
{
"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"
}
}