setValue | Write | Sets (or overwrites) this field's value for the entity. |
|---|
clearValue | Write | Clears this field's value for the entity — there is no separate value resource to delete, so this is the only way to unset a field. |
|---|
getSubmittal | Read | Get a submittal by GUID (Tags: Submittal) |
|---|
updateSubmittal | Write | Update a submittal (Tags: Submittal) |
|---|
deleteSubmittal | Write | Delete a submittal (Tags: Submittal) |
|---|
getSubmittalActivity | Read | Get a submittal activity by GUID (Tags: Submittal Activities) |
|---|
updateSubmittalActivity | Write | Update a submittal activity (Tags: Submittal Activities) |
|---|
deleteSubmittalActivity | Write | Delete a submittal activity (Tags: Submittal Activities) |
|---|
getRequirement | Read | Returns the full detail of a single requirement (job opening): core fields, compensation and rate types, placement type and job group, ass… |
|---|
updateRequirement | Write | Partially updates a requirement (job opening). |
|---|
deleteRequirement | Write | Permanently deletes a requirement (job opening) along with its recruiter/sourcer/vendor/category/industry/function/workgroup assignments. |
|---|
getPlacement | Read | Get a placement by GUID (Tags: Placement) |
|---|
updatePlacement | Write | Update a placement (Tags: Placement) |
|---|
deletePlacement | Write | Delete a placement (Tags: Placement) |
|---|
getOpportunity | Read | Returns the full detail of a single sales opportunity including its stage, estimated value, assigned sales representatives, and associated… |
|---|
updateOpportunity | Write | Partially updates a sales opportunity. |
|---|
deleteOpportunity | Write | Permanently deletes a sales opportunity and all of its associated data (sales representatives, contacts, attachments, line items). |
|---|
getClient | Read | Returns full client detail including billing profile, sales assignments, workgroup, term, phones, and tags. |
|---|
updateClient | Write | Partially updates a client. |
|---|
deleteClient | Write | Soft-deletes the client and associated offices according to internal business rules. |
|---|
getOffice | Read | Get a client office by GUID (Tags: Office) |
|---|
updateOffice | Write | Update a client office (Tags: Office) |
|---|
deleteOffice | Write | Delete a client office (Tags: Office) |
|---|
getContact | Read | Get a contact by GUID (Tags: Contact) |
|---|
updateContact | Write | Update a contact (Tags: Contact) |
|---|
deleteContact | Write | Delete a contact (Tags: Contact) |
|---|
getApplicant | Read | Returns the full detail of a single applicant (candidate): contact info, classification and EEOC/compliance fields, compensation, and embe… |
|---|
updateApplicant | Write | Partially updates an applicant (candidate). |
|---|
deleteApplicant | Write | Permanently deletes an applicant (candidate) along with its phones, education, employment history, notes, tags, social links, and resumes. |
|---|
searchUniversal | Read | Runs a single free-text query against the aggregated cross-entity index. |
|---|
listSubmittals | Read | List submittals. Either requirementGuid or applicantGuid must be supplied. |
|---|
createSubmittal | Write | Create a submittal (submit an applicant to a requirement) (Tags: Submittal) |
|---|
listSubmittalActivities | Read | List submittal activities for a submittal (identified by requirementGuid + applicantGuid) (Tags: Submittal Activities) |
|---|
createSubmittalActivity | Write | Create a submittal activity (Tags: Submittal Activities) |
|---|
listRequirements | Read | Returns a paginated list of requirements (job openings) belonging to the authenticated user's company, optionally filtered by a free-text… |
|---|
createRequirement | Write | Creates a new requirement (job opening) linked to an existing client, client office, and client contact. |
|---|
assignWorkgroup | Write | Assigns a workgroup to this requirement. |
|---|
removeWorkgroup | Write | Removes a previously-assigned workgroup from this requirement. |
|---|
assignVendor | Write | Assigns an existing vendor (staffing partner/subcontractor) to this requirement. |
|---|
removeVendor | Write | Removes a previously-assigned vendor from this requirement. |
|---|
listClientTags | Read | Returns every tag currently assigned to this requirement. |
|---|
assignClientTag | Write | Assigns a tag (by name) to this requirement. |
|---|
assignSourcer | Write | Assigns an existing employee as a sourcer on this requirement. |
|---|
removeSourcer | Write | Removes a previously-assigned sourcer from this requirement. |
|---|
assignRecruiter | Write | Assigns an existing employee as a recruiter on this requirement. |
|---|
removeRecruiter | Write | Removes a previously-assigned recruiter from this requirement. |
|---|
addLocation | Write | Adds an additional location this requirement should be posted/marketed to, beyond its primary work location. |
|---|
assignIndustry | Write | Assigns a job industry to this requirement. |
|---|
removeIndustry | Write | Removes a previously-assigned job industry from this requirement. |
|---|
assignFunction | Write | Assigns a job function to this requirement. |
|---|
removeFunction | Write | Removes a previously-assigned job function from this requirement. |
|---|
assignCategory | Write | Assigns a job category to this requirement. |
|---|
removeCategory | Write | Removes a previously-assigned job category from this requirement. |
|---|
setApproval | Write | Records an approval or rejection event for this requirement, updating its approval status accordingly. |
|---|
listPlacements | Read | List placements (Tags: Placement) |
|---|
createPlacement | Write | Create a placement (Tags: Placement) |
|---|
listOpportunities | Read | Returns a paginated list of all sales opportunities belonging to the authenticated user's company. |
|---|
createOpportunity | Write | Creates a new sales opportunity linked to an existing client. |
|---|
assignSalesRep | Write | Assigns an existing employee as a sales representative on this opportunity. |
|---|
removeSalesRep | Write | Removes a previously-assigned sales representative from this opportunity. |
|---|
listLineItems | Read | Returns every line item (role/position) recorded against this opportunity. |
|---|
addLineItem | Write | Adds a new line item (role/position) to this opportunity. |
|---|
assignContact | Write | Assigns an existing client contact to this opportunity. |
|---|
removeContact | Write | Removes a previously-assigned client contact from this opportunity. |
|---|
listOpportunityAttachments | Read | Returns metadata for every file attachment on file for this opportunity. |
|---|
addOpportunityAttachment | Write | Uploads a file attachment for this opportunity. |
|---|
searchJobs | Read | Runs a full-text and filter-based search across jobs (requirements) visible to the authenticated user. |
|---|
searchContacts | Read | Runs a full-text and filter-based search across contacts visible to the authenticated user. |
|---|
listClients | Read | Returns a paginated list of active clients for the authenticated user's company. |
|---|
createClient | Write | Creates a new client company. |
|---|
listClientContactTags | Read | Returns every tag currently assigned to this client. |
|---|
assignClientContactTag | Write | Assigns a tag (by name) to this client. |
|---|
listClientNotes | Read | Returns every note recorded against this client. |
|---|
addClientNote | Write | Adds a new note to this client. |
|---|
listClientAttachments | Read | Returns metadata for every file attachment on file for this client. |
|---|
addClientAttachment | Write | Uploads a file attachment for this client. |
|---|
listOffices | Read | List client offices (Tags: Office) |
|---|
createOffice | Write | Create a client office (Tags: Office) |
|---|
listClientOfficePhones | Read | Returns every phone number recorded against this client office. |
|---|
addClientOfficePhone | Write | Adds a new phone number to this client office. |
|---|