Crelate

Returns a paged list of activity records. Filter by parent record, verb type, date range, or other criteria.

Returns a single Activities record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Activities type. This data changes rarely and Crelate recommends caching…

Creates a new Activities record and returns its generated ID.

Partially updates an existing Activities record. Only fields included in the request body are modified; omitted fields a…

Permanently deletes an Activity record by its unique identifier.

Creates a new Activity record and simultaneously uploads and links one or more files as Artifacts via a multipart form…

Records must match all filters provided unless the OR filter operator is specified. <br> If no sort_by is provided, the…

Returns a single Applications record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Applications type. This data changes rarely and Crelate recommends cachi…

Approved applicants will be moved to the next workflow stage, typically with a meaning of “in progress”.

When an applicant is blocked, they are no longer visible and any future applications from that applicant will be discard…

Rejected applicants will be moved to a closed negative workflow stage.

Submits an application to a Job and returns the created application ID. Depending on settings, applicants either route t…

Records must match all filters provided unless the OR filter operator is specified.<br /> If no sort_by is provided, the…

Returns a single Companies record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Companies type. This data changes rarely and Crelate recommends caching…

Creates a new Companies record and returns its generated ID.

Partially updates an existing Companies record. Only fields included in the request body are modified; omitted fields ar…

Permanently deletes a Company record by its unique identifier.

Available statuses can be retrieved by inspecting the results of the Companies metadata endpoint under the `EntityStatus…

Returns Companies records that belong to the specified saved list.

Performs a keyword search against all Company records (name, phone, address, website, or other keyword). Returned data i…

Records must match all filters provided unless the OR filter operator is specified. <br> If no sort_by is provided, the…

Returns a single Contacts record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Contacts type. This data changes rarely and Crelate recommends caching i…

Creates a new Contacts record and returns its generated ID.

Partially updates an existing Contacts record. Only fields included in the request body are modified; omitted fields are…

Permanently deletes a Contact record by its unique identifier.

Available statuses can be retrieved by inspecting the results of the Contacts metadata endpoint under the EntityStatus…

Returns Contacts records that belong to the specified saved list.

Performs a keyword search against all Contact records (name, contact number, phone, address, website, or other keyword)…

Returns a paged, filterable list of job records. Supports filtering by stage, company, tags, candidates, and more.

Returns a single Jobs record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Jobs type. This data changes rarely and Crelate recommends caching it.

Creates a new Jobs record and returns its generated ID.

Partially updates an existing Jobs record. Only fields included in the request body are modified; omitted fields are lef…

Permanently deletes a Job record by its unique identifier.

Adds a single contact to the specified job’s recruiting pipeline at the given workflow stage.

Adds one or more contacts to the specified job’s recruiting pipeline at the given workflow stage.

This endpoint does not support handling workflow rules. Consider migrating to the Workflow Stage…

Removes a contact from the specified job’s recruiting pipeline.

Updates the public-facing portal posting details for a job, such as title, description, location, and compensation. Only…

Disables the job’s portal posting and removes it from any free job boards it was published to. The job record itself is…

Returns Jobs records that belong to the specified saved list.

Search Job postings for open Jobs that are not hidden against the Job’s title, description, compensation, city, state, z…

Performs a keyword search against all Job records (name, job number, location, website, or other keyword). Returned data…

Returns a paged list of note activities. Filter by parent record, date range, or other criteria.

Returns a single note activity by its unique identifier.

Creates a new note activity on a parent record. A ParentId is required.

Partially updates a note activity. Only fields included in the request body are modified.

Permanently deletes a note activity by its unique identifier.

Records must match all filters provided unless the OR filter operator is specified. <br> If no sort_by is provided, the…

Returns a single Placements record by its unique identifier. Returns a 404 if the record does not exist.

Retrieves attribute information specific to the Placements type. This data changes rarely and Crelate recommends caching…

Available statuses can be retrieved by inspecting the results of the Placements metadata endpoint under the `EntityStatu…

Returns a paged list of task activities. Filter by parent record, completion state, date range, or other criteria.

Returns a single task activity by its unique identifier.

Tasks will default to being incomplete (Completed = false) unless a value is provided.

Partially updates a task activity. Only fields included in the request body are modified.

Permanently deletes a task activity by its unique identifier.