Emails and Phones have changed in structure in CATS, this has results in some changes and deprecations in the API.
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._embedded
object. For updating and deleting them, there are several new endpoints that can be found in the documentation.Careers Website
to Career Portal
/portal/{id}/registration
endpoints for fetching and submitting portal registration applications.annotation
field on Activities now correctly includes the name of the appropriate status (or other variable data).text_message
is now a valid activity typeUpdated 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.
/candidates/{candidate_id}/phones
endpoints./companies/{company_id}/phones
endpoints./contacts/{contact_id}/phones
endpoints.Added beta (subject to change) version of events to CATS UI and API:
/events
Candidate registration has been added to the API:
password
field to candidates that is not returned from GETs but can be set in a POST or PUT.is_registered
field to candidate GETs that indicated whether a password has been set for that candidate./candidates/authorization
endpoint which accepts an email and password, and if they match an existing registered candidate, returns that candidate.is_published
field to jobs.DEPRECATION:
is_active
field to candidates.department_id
field to jobs.DEPRECATION:
items
key to pass a list of items.max_rate
field to jobs.DEPRECATION:
/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.BREAKING CHANGES:
source
field has been added to candidates. Additionally source
can also be specified when submitting an application to a portal.date
can now be set when creating an activityBREAKING 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.date_created
and date_modified
fields to Jobs, Pipelines, and Activities endpointswebhooks
endpoint is now available. Webhooks events can now be subscribed to.tags
endpoint now available for candidates
, contacts
, companies
and jobs
.backups
endpoint is now available.tasks
endpoint is now available./portals
, /candidates/applications
, and /job/applications
.users
endpoint now return a user's access_level
.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.NEW ENDPOINTS:
lists
endpoints are now available for candidates
, contacts
, companies
and jobs
.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.BREAKING CHANGES:
custom_field
endpoints have been removed in favor of more specific endpoints./candidates/custom_fields
, /companies/custom_fields
, /contacts/custom_fields
, and /jobs/custom_fields
.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
.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.BREAKING CHANGES:
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
.search
endpoint is now available for activities
, candidates
, companies
, contacts
, and jobs
social_media
field is now available for candidates
and contacts
.work_history
endpoint is now available for candidates
.BREAKING CHANGES:
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.mapping
property now returns the name of the mapping instead of a numeric ID.NEW ENDPOINTS:
attachments
endpoint is now available for candidates
, contacts
, companies
and jobs
.IMPROVEMENTS:
NEW ENDPOINTS:
pipelines
endpoint is now available.statuses
endpoints are are now available for pipelines
, contacts
, companies
and jobs
.triggers
endpoint is now available.BREAKING CHANGES:
value
property now returns the ID of the selection for the radio
and dropdown
field types.BREAKING CHANGES:
Authentication:
Authorization
header has changed to the format: Authorization: Token <API key>
.Request bodies:
Content-Type
header is not set, the default is now application/json
.Pagination:
perPage
URL parameter has been renamed to per_page
.per_page
is now 100.Email addresses:
email_address
and secondary_email_address
. These properties are now part of an emails
object, with the keys primary
and secondary
.Phone numbers:
home_phone
, cell_phone
etc. These are now part of a phones
object.Miscellaneous:
city_name
property has been renamed to city
.state_name
property has been renamed to state
.type
property is no longer prefixed with type_
.entered_by
property has been renamed to entered_by_id
.entered_by
property has been renamed to entered_by_id
.entered_by
property has been renamed to entered_by_id
and now returns the ID of the user that created the record.contact_numbers
property has been renamed to phones
.entered_by
property has been renamed to entered_by_id
and now returns the ID of the user that created the record.category_name
property has been renamed to category
.is_published
property has been removed.dataItemType
property has been renamed to data_item_type
.name
property of field
has been renamed to type
.IMPROVEMENTS:
entered_by
is now included in the _links
property of Candidates, Contacts and Companies.IMPROVEMENTS:
IMPROVEMENTS:
is_hot
and is_published
properties.IMPROVEMENTS:
owner_id
and recruiter_id
properties.IMPROVEMENTS:
IMPROVEMENTS:
IMPROVEMENTS:
IMPROVEMENTS:
BREAKING CHANGES:
street_name
property of the address
object has been renamed to street
.IMPROVEMENTS:
owner_id
, is_hot
, key_technologies
and billing_contact_id
properties.BREAKING CHANGES:
social_media
property has been renamed to social_media_urls
.