← Tools Reference

Gem

Gem integration (Productivity, Data). Imported from open-connector.

API key9 toolshttps://api.gem.com
GET
gem_list_users
List Gem users visible to the current API key.

/v0/users

3 parameters
ParamTypeRequiredDescription
emailstringoptionalFilter records by email address.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.
GET
gem_list_candidates
List candidates in Gem CRM.

/v0/candidates

11 parameters
ParamTypeRequiredDescription
created_afterintegeroptionalOnly return records created after this Unix timestamp in seconds.
created_beforeintegeroptionalOnly return records created before this Unix timestamp in seconds.
sortstringoptionalThe sort direction for Gem results.
created_bystringoptionalOnly return candidates added to Gem by this user ID.
emailstringoptionalFilter records by email address.
linked_in_handlestringoptionalOnly return candidates with this LinkedIn handle.
updated_afterintegeroptionalOnly return candidates updated after this Unix timestamp in seconds.
updated_beforeintegeroptionalOnly return candidates updated before this Unix timestamp in seconds.
candidate_idsarrayoptionalCandidate IDs to include. Gem accepts at most 20 IDs.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.
GET
gem_get_candidate
Get one Gem candidate by ID.

/v0/candidates/{candidate_id}

1 parameter
ParamTypeRequiredDescription
candidate_idstringrequiredThe Gem candidate ID.
GET
gem_list_projects
List projects in Gem CRM.

/v0/projects

9 parameters
ParamTypeRequiredDescription
created_afterintegeroptionalOnly return records created after this Unix timestamp in seconds.
created_beforeintegeroptionalOnly return records created before this Unix timestamp in seconds.
sortstringoptionalThe sort direction for Gem results.
user_idstringoptionalOnly return projects owned by this user ID.
readable_bystringoptionalOnly return projects this user ID can read.
writable_bystringoptionalOnly return projects this user ID can update.
is_archivedbooleanoptionalWhether to return archived projects.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.
GET
gem_get_project
Get one Gem project by ID.

/v0/projects/{project_id}

1 parameter
ParamTypeRequiredDescription
project_idstringrequiredThe Gem project ID.
GET
gem_list_project_candidates
List candidate memberships in a Gem project.

/v0/projects/{project_id}/candidates

6 parameters
ParamTypeRequiredDescription
project_idstringrequiredThe Gem project ID.
added_afterintegeroptionalOnly return memberships added after this Unix timestamp in seconds.
added_beforeintegeroptionalOnly return memberships added before this Unix timestamp in seconds.
sortstringoptionalThe sort direction for Gem results.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.
GET
gem_list_sequences
List outreach sequences in Gem.

/v0/sequences

6 parameters
ParamTypeRequiredDescription
created_afterintegeroptionalOnly return records created after this Unix timestamp in seconds.
created_beforeintegeroptionalOnly return records created before this Unix timestamp in seconds.
sortstringoptionalThe sort direction for Gem results.
user_idstringoptionalOnly return sequences owned by this user ID.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.
GET
gem_get_sequence
Get one Gem sequence by ID.

/v0/sequences/{sequence_id}

1 parameter
ParamTypeRequiredDescription
sequence_idstringrequiredThe Gem sequence ID.
GET
gem_list_custom_fields
List custom fields configured in Gem.

/v0/custom_fields

9 parameters
ParamTypeRequiredDescription
created_afterintegeroptionalOnly return records created after this Unix timestamp in seconds.
created_beforeintegeroptionalOnly return records created before this Unix timestamp in seconds.
sortstringoptionalThe sort direction for Gem results.
project_idstringoptionalOnly return project-scoped fields for this Gem project ID.
scopestringoptionalThe custom field scope to return.
is_hiddenbooleanoptionalWhether to return hidden custom fields.
namestringoptionalFilter custom fields by name.
pageintegeroptionalThe 1-indexed page number to request.
page_sizeintegeroptionalThe number of records to return per page, from 1 to 100.