CATS API v3 Changelog

3.0.21 (Winter 2019)

Emails and Phones have changed in structure in CATS, this has results in some changes and deprecations in the API.

• Both emails and phones are now no longer limited to 2 and 3 entries respectively. A record can have any number of emails (e.g. 1 primary and 5 other emails) and any number of phones of any type (e.g. 2 mobile and 1 home number)
• Existing email and phone on records are deprecated. They will continue to work in some capacity for the purposes of backwards compatibility, however due to the nature of the changes made, they cannot fully take advantage of all the new features the new phone and email fields have access to. It is highly recommended to switch over to the new fields and endpoints for the most consistent experience.
• New emails and phones are treated as separate objects now that are embedded in their parent's _embedded object. For updating and deleting them, there are several new endpoints that can be found in the documentation.
• While the email and phone fields on the records are deprecated in favor of the embedded fields, there is an allowance for creating them along with the parent record, exactly like how we currently handle custom fields.

3.0.20 (December 3, 2018)

• Changed the default job application source from Careers Website to Career Portal

3.0.19 (November 9, 2018)

• Added /portal/{id}/registration endpoints for fetching and submitting portal registration applications.

3.0.18 (August 13, 2018)

• The annotation field on Activities now correctly includes the name of the appropriate status (or other variable data).

3.0.17 (June 4, 2018)

• text_message is now a valid activity type

3.0.16 (February 8, 2018)

Updated the API to support CATS' new phone numbers. The old way of getting and setting phone numbers will continue to work for some amount of time, but it should be considered deprecated and will not work with the full new functionality that comes with the new endpoints.

Phones now are a separate object in the API and are treated as such. You can find them embedded on Candidates, Contacts, and Companies, and they can be created, updated, deleted, and fetched at their own set of endpoints.

• Added /candidates/{candidate_id}/phones endpoints.
• Added /companies/{company_id}/phones endpoints.
• Added /contacts/{contact_id}/phones endpoints.

3.0.15 (November 20, 2017)

Added beta (subject to change) version of events to CATS UI and API:

• Every event is now recorded in CATS (the same events that fire webhooks)
• Events can be fetched from a new endpoint: /events

3.0.14 (October 17, 2017)

Candidate registration has been added to the API:

• Added password field to candidates that is not returned from GETs but can be set in a POST or PUT.
• Added is_registered field to candidate GETs that indicated whether a password has been set for that candidate.
• Added /candidates/authorization endpoint which accepts an email and password, and if they match an existing registered candidate, returns that candidate.
• Using the above additions, you should have the tools you need to "log in" applicants and allow them to view or edit any profile data you choose to expose to them.

3.0.13 (September 26, 2017)

• Added is_published field to jobs.

3.0.12 (September 26, 2017)

• Publish and Unpublish endpoints have been added for publishing jobs to portals.

3.0.11 (September 20, 2017)

• Webhooks have been added for pipeline creation and deletion events.

DEPRECATION:

• Starting next September 27th, creating or deleting a pipeline will no longer trigger a candidate updated webhook.

3.0.10 (September 18, 2017)

• Added is_active field to candidates.

3.0.9 (September 14, 2017)

• Added department_id field to jobs.

3.0.8 (September 8, 2017)

• Webhooks have been added for deletion events.

3.0.7 (September 5, 2017)

• Thumbnails have been added to the API. Candidates, Contacts, and Companies now have them embedded, and thumbnails can be changed for all of them.

3.0.6 (August 18, 2017)

• Certain endpoints (pipeline creation, pipeline deletion, pipeline status change, and contact status change) now have flags to enable the automatic creation of activities related to that action.

3.0.5 (July 27, 2017)

• List items can now be added in bulk to lists instead of one at a time.

DEPRECATION:

• Passing a single list item object to the list item creation endpoints is deprecated. Instead use the items key to pass a list of items.

3.0.4 (June 26, 2017)

• Added max_rate field to jobs.

3.0.3 (June 12, 2017)

• Pipelines can now have multiple workflows, each with its own set of statuses.
• Jobs can be assigned a Pipeline workflow on creation.

DEPRECATION:

• The /pipelines/statuses endpoint is deprecated. It will still work and return the statuses on the first (lowest id) pipeline workflow. This results in no change for people not using the new multiple workflow functionality. Use /pipelines/workflows/{workflow_id}/statuses now.

3.0.2 (May 9, 2017)

• An endpoint has been added for parsing resumes.
• Work History can now be set on a Candidate creation call.

3.0.1 (April 13, 2017)

• An endpoint has been added for pipeline filtering.

3.0.0-beta35 (March 31, 2017)

BREAKING CHANGES:

• Departments on companies are not longer returned as a simple array of names. They now have their own endpoint where they can be added and edited. Companies will have them as embedded objects.

3.0.0-beta34 (March 28, 2017)

• Custom fields can now be filtered on.

3.0.0-beta33 (Feb 28, 2017)

• Search filtering has been added to all endpoints with search. See the documentation for an explanation on formatting.

3.0.0-beta32 (Feb 27, 2017)

• The source field has been added to candidates. Additionally source can also be specified when submitting an application to a portal.

3.0.0-beta31 (Sep 12, 2016)

• date can now be set when creating an activity

BREAKING CHANGES:

• date_created on activities is now the date the activity was created, and no longer the date the activity took place. That value is now contained in the date field.

3.0.0-beta31 (Sep 12, 2016)

• Added date_created and date_modified fields to Jobs, Pipelines, and Activities endpoints

3.0.0-beta30 (Aug 18, 2016)

• webhooks endpoint is now available. Webhooks events can now be subscribed to.

3.0.0-beta29 (Aug 9, 2016)

• tags endpoint now available for candidates, contacts, companies and jobs.

3.0.0-beta28 (Aug 1, 2016)

• backups endpoint is now available.

3.0.0-beta27 (Jul 25, 2016)

• tasks endpoint is now available.

3.0.0-beta26 (Jul 14, 2016)

• Rate limit per hour is no longer based on number of users. Instead the default limit is a flat 500 requests per hour.

3.0.0-beta25 (May 31, 2016)

• Portal related endpoints have been added. These include /portals, /candidates/applications, and /job/applications.

3.0.0-beta24 (May 6, 2016)

• The users endpoint now return a user's access_level.

3.0.0-beta23 (May 6, 2016)

• The candidates, companies, contacts, and jobs create endpoints now accept the query parameter check_duplicate which can be set to true or false (defaults to false). Setting this to true will return a 409 error and id of the first duplicate found and will not create the item.

3.0.0-beta22 (April 29, 2016)

NEW ENDPOINTS:

• The lists endpoints are now available for candidates, contacts, companies and jobs.

3.0.0-beta21 (April 26, 2016)

• work_history can now be linked to a company and a contact by id, instead of manually having to add employer and supervisor data to a work history.

3.0.0-beta20 (April 13, 2016)

BREAKING CHANGES:

• The custom_field endpoints have been removed in favor of more specific endpoints.
• Custom field definitions can now be found at /candidates/custom_fields, /companies/custom_fields, /contacts/custom_fields, and /jobs/custom_fields.
• All PUT endpoints no longer require all fields to be included. Fields that are not included will not be modified. To delete the data from a field, set it to null.
• Custom fields can now be set en masse via the POST and PUT endpoints for candidates, companies, contacts, and jobs. Just include an array of custom field objects in the call as per the documentation for each of those endpoints.

3.0.0-beta19 (April 4, 2016)

BREAKING CHANGES:

• The Content-Type and Accept headers are now more strictly enforced. Invalid values for these headers will now return an error. An invalid Content-Type will now return 415 Unsupported Media Type, and an invalid Accept will now return 406 Not Acceptable.

3.0.0-beta18 (April 1, 2016)

• The search endpoint is now available for activities, candidates, companies, contacts, and jobs

3.0.0-beta17 (March 29, 2016)

• The social_media field is now available for candidates and contacts.

3.0.0-beta16 (March 28, 2016)

• The work_history endpoint is now available for candidates.

3.0.0-beta15 (March 23, 2016)

BREAKING CHANGES:

• Validation of POST and PUT requests has changed significantly. The errors property now refers to invalid properties of a request with the property field, and the error message should more accurately reflect the name of the invalid property.
• statuses: The mapping property now returns the name of the mapping instead of a numeric ID.

3.0.0-beta14 (March 22, 2016)

NEW ENDPOINTS:

• The attachments endpoint is now available for candidates, contacts, companies and jobs.

3.0.0-beta13

IMPROVEMENTS:

• Support for cross-origin resource sharing (CORS) has been added.

3.0.0-beta12 (March 2, 2016)

NEW ENDPOINTS:

• The pipelines endpoint is now available.
• The statuses endpoints are are now available for pipelines, contacts, companies and jobs.
• The triggers endpoint is now available.

BREAKING CHANGES:

• custom_fields: The value property now returns the ID of the selection for the radio and dropdown field types.

3.0.0-beta11 (February 29, 2016)

BREAKING CHANGES:

Authentication:

• The Authorization header has changed to the format: Authorization: Token <API key>.

Request bodies:

• Request bodies are now required to be in JSON format. Form data is no longer accepted.
• If a request's Content-Type header is not set, the default is now application/json.

Pagination:

• The perPage URL parameter has been renamed to per_page.
• The maximum value of per_page is now 100.

Email addresses:

• Several resources have multiple email address properties. In the previous version, these were typically email_address and secondary_email_address. These properties are now part of an emails object, with the keys primary and secondary.

Phone numbers:

• Resources that contain phone numbers previously contained properties at the root of the resource object. For example, home_phone, cell_phone etc. These are now part of a phones object.

Miscellaneous:

• address: The city_name property has been renamed to city.
• address: state_name property has been renamed to state.
• activities: The value of the type property is no longer prefixed with type_.
• activities: The entered_by property has been renamed to entered_by_id.
• candidates: The entered_by property has been renamed to entered_by_id.
• contacts: The entered_by property has been renamed to entered_by_id and now returns the ID of the user that created the record.
• companies: The contact_numbers property has been renamed to phones.
• companies: The entered_by property has been renamed to entered_by_id and now returns the ID of the user that created the record.
• jobs: The category_name property has been renamed to category.
• jobs: The is_published property has been removed.
• custom_fields: The dataItemType property has been renamed to data_item_type.
• custom_fields: The name property of field has been renamed to type.

IMPROVEMENTS:

• entered_by is now included in the _links property of Candidates, Contacts and Companies.

3.0.0-beta10 (January 27, 2016)

IMPROVEMENTS:

• Creating or updating Jobs and Activities now performs validation of the request object.

3.0.0-beta9 (January 22, 2016)

IMPROVEMENTS:

• jobs: Now returns the is_hot and is_published properties.

3.0.0-beta8 (January 19, 2016)

IMPROVEMENTS:

• jobs: Now returns the owner_id and recruiter_id properties.

3.0.0-beta7 (September 9, 2015)

IMPROVEMENTS:

• The activities resource has been added.

3.0.0-beta6 (September 2, 2015)

IMPROVEMENTS:

• The custom_fields resource has been added.

3.0.0-beta5 (August 5, 2015)

IMPROVEMENTS:

• candidates: Creating or updating a candidate now performs validation of the request object.

3.0.0-beta4 (July 30, 2015)

IMPROVEMENTS:

• Pagination of the list endpoints has been added.

3.0.0-beta3 (July 28, 2015)

BREAKING CHANGES:

• companies: The street_name property of the address object has been renamed to street.

IMPROVEMENTS:

• companies: Now returns the owner_id, is_hot, key_technologies and billing_contact_id properties.
• companies: Updating a company now performs validation of the request object.

3.0.0-beta2 (July 27, 2015)

BREAKING CHANGES:

• companies: The social_media property has been renamed to social_media_urls .

3.0.0-beta1 (July 24, 2015)

• Initial release.