{"openapi":"3.0.3","info":{"title":"Recruitment Marketing V2","version":"2.0.0","description":"Interactive documentation for the [PageUp Recruitment Marketing](https://www.pageuppeople.com/products/recruitment-marketing/) API.\n\nFor information on accquiring your API credentials and implementing your own API client please refer to our [PageUp Knowledge Portal](https://knowledgeportal.pageuppeople.com/hc/en-gb/articles/17127248228249-Clinch-API-Getting-Started).\n\nPlease ensure you are on the correct region for your account.\n\n* [US Region](https://api.clinchtalent.com/v2/openapi)\n* [EU Region](https://api.rec-marketing.dc3.pageuppeople.com/v2/openapi)\n* [AU Region](https://api.rec-marketing.dc2.pageuppeople.com/v2/openapi)\n\nPlease note the `x-hmac-date` header can be replaced with a regular `date` header.\n\nWhen authorizing please use your API key & secret in place of username & password.\n"},"servers":[{"url":"https://api.rec-marketing.dc2.pageuppeople.com/v2"}],"paths":{"/candidates":{"get":{"summary":"List candidates","description":"List known candidates with options to paginate, filter and return related resources(e.g. social_profile).","operationId":"listCandidates","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/candidateInclude"},{"$ref":"#/components/parameters/candidateFilter"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"}}},"post":{"summary":"Add a new candidate","description":"Returns a new candidate object","operationId":"createCandidate","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"candidate"},"attributes":{"type":"object","required":["email"],"properties":{"first_name":{"type":"string","example":"Jane"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","format":"email","example":"jane.smith@example.com"},"phone_number":{"type":"string","example":"+1-202-555-0169"},"tag_values":{"type":"array","items":{"type":"string"},"example":["foo","bar"]}}}}}}}}}},"responses":{"201":{"description":"Created"},"401":{"description":"Invalid API credentials"},"422":{"description":"Unprocessable entity"}}}},"/candidates/{candidateId}":{"get":{"summary":"Find candidate by ID","description":"Returns a candidate and optionally includes related resources(e.g. social_profile).","operationId":"getCandidate","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/candidateInclude"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}},"patch":{"summary":"Update candidate by ID","operationId":"updateCandidate","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"}],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"candidate"},"attributes":{"type":"object","properties":{"first_name":{"type":"string","example":"New first name"},"last_name":{"type":"string","example":"New last name"},"skills":{"type":"array","items":{"type":"string"},"example":["programming","marketing"]}}}}}}}}}},"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity"}}}},"/candidates/{candidateId}/events":{"get":{"summary":"List candidate events","description":"List the events associated with a candidate","operationId":"getCandidateEvents","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/eventInclude"},{"$ref":"#/components/parameters/eventFilter"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/candidates/{candidateId}/tags":{"get":{"summary":"List candidate tags","description":"List the tags for a candidate","operationId":"getCandidateTag","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}},"post":{"summary":"Create candidate tag","description":"Creates a tag for a candidate","operationId":"createCandidateTag","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"tag"},"attributes":{"type":"object","required":["email"],"properties":{"name":{"type":"string","example":"Tag Name"}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/candidates/{candidateId}/tags/{tagId}":{"delete":{"summary":"Delete candidate tag","description":"Deletes a candidate tag","operationId":"deleteCandidateTag","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"in":"path","name":"tagId","description":"UUID of the tag to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/candidates/{candidateId}/candidate_files":{"post":{"summary":"Upload a candidates resume","description":"Upload a candidates resume. Both filename and content are mandatory. Content should be a base64 encoded string.","operationId":"createCandidateFile","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"candidate_files"},"attributes":{"type":"object","required":["filename","content"],"properties":{"filename":{"type":"string","description":"resume.pdf"},"content":{"type":"string","format":"byte","description":"base64 encoded string"}}},"options":{"type":"object","properties":{"parse_resume":{"type":"boolean","description":"enable resume parsing for file"}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"201":{"description":"Created - File was added to the Candidate."},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"},"422":{"description":"Unprocessable entity - File was not added to the Candidate."}}}},"/ats_integrations/{atsIntegrationId}/candidates/{candidateAtsId}":{"delete":{"summary":"Anonymise candidate by ATS ID","description":"On success a candidate is placed in a queue to be anonymised. Only available on the ATS's listed below\n\n| ATS | CandidateAtsId |\n| --- | --- |\n| Greenhouse | `id` |\n| Workday | `Candidate_ID` |\n","operationId":"anonymiseAtsCandidate","tags":["Candidate"],"parameters":[{"in":"path","name":"atsIntegrationId","description":"ATS Integration UUID from PageUp Recruitment Marketing","required":true,"schema":{"type":"string"}},{"in":"path","name":"candidateAtsId","description":"Candidate ID from your ATS. see above for mapping","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Candidate has been queued for anonymisation"},"401":{"description":"Invalid API credentials"},"404":{"description":"Ats Integration or Candidate were not found"}}}},"/candidates/{candidateId}/educations":{"get":{"summary":"List candidate educations","description":"List the educations of a candidate","operationId":"listCandidateEducations","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}},"post":{"summary":"Create new candidate education","description":"Create a new education record for the candidate. This can be a university, high school or certificate qualification.","operationId":"createCandidateEducation","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"educations"},"attributes":{"type":"object","required":["school"],"properties":{"school":{"type":"object","properties":{"name":{"type":"string","example":"Trinity College Dublin"}}},"course":{"type":"string","example":"Computer Science"},"start_date":{"type":"string","format":"date","example":"01-01-2019"},"end_date":{"type":"string","format":"date","example":"01-01-2023"}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"Success"},"201":{"description":"Created"},"401":{"description":"Invalid API credentials"},"422":{"description":"Validation failed Name can't be blank"}}}},"/candidates/{candidateId}/educations/{educationId}":{"get":{"summary":"Find candidate education record by ID","description":"Returns a single candidate education record","operationId":"getCandidateEducation","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/educationId"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/candidates/{candidateId}/employments":{"get":{"summary":"List candidate employments","description":"List the employments/experiences of a candidate","operationId":"listCandidateEmployments","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}},"post":{"summary":"Create new candidate employment","description":"Create a new employment record for the candidate. This can be any experience or job the candidate has had in the past.","operationId":"createCandidateEmployment","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","example":"employments"},"attributes":{"type":"object","required":["company name"],"properties":{"company":{"type":"object","properties":{"name":{"type":"string","example":"PageUp"}}},"title":{"type":"string","example":"Sales Development Representative"},"locality":{"type":"string","example":"Dublin"},"start_date":{"type":"string","format":"date","example":"01-01-2019"},"end_date":{"type":"string","format":"date","example":"01-01-2023"}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"Success"},"201":{"description":"Created"},"401":{"description":"Invalid API credentials"},"422":{"description":"Validation failed Name can't be blank"}}}},"/candidates/{candidateId}/employments/{employmentId}":{"get":{"summary":"Find candidate employment record by ID","description":"Returns a single candidate employment record","operationId":"getCandidateEmployment","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"},{"$ref":"#/components/parameters/employmentId"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/candidates/{candidateId}/job_alert_subscriptions":{"get":{"summary":"List active candidate job alert subscriptions","description":"List the job alert subscriptions currently active for a candidate.","operationId":"getJobAlertSubscriptions","tags":["Candidate"],"parameters":[{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/job_applications/{jobApplicationId}/events":{"get":{"summary":"List candidate events for a job application","description":"List the events associated with a job application","operationId":"getJobApplicationEvents","tags":["Job Application Events"],"parameters":[{"$ref":"#/components/parameters/jobApplicationId"},{"$ref":"#/components/parameters/jobApplicationEventInclude"},{"$ref":"#/components/parameters/jobApplicationEventFilter"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}},"/recruitment_events/{recruitmentEventId}":{"get":{"summary":"Find recruitment event by ID","description":"Return a recruitment event with optional includes.","operationId":"listRecruitmentEvents","tags":["Recruitment events"],"parameters":[{"in":"path","name":"recruitmentEventId","description":"Recruitment Event ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/recruitmentEventInclude"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"},"404":{"description":"Ats Integration or Candidate were not found"}}}},"/recruitment_events/upcoming":{"get":{"summary":"Find upcoming recruitment events","description":"Return a list of the upcoming recruitment events","operationId":"listUpcomingRecruitmentEvents","tags":["Recruitment events"],"parameters":[{"$ref":"#/components/parameters/recruitmentEventInclude"}],"responses":{"200":{"description":"Success"}}}},"/recruitment_events/past":{"get":{"summary":"Find past recruitment events","description":"Return a list of the past recruitment events","operationId":"listPastRecruitmentEvents","tags":["Recruitment events"],"parameters":[{"$ref":"#/components/parameters/recruitmentEventInclude"}],"responses":{"200":{"description":"Success"}}}},"/recruitment_events/in_progress":{"get":{"summary":"Find the current recruitment events","description":"Return a list of the recruitment events currently in progress","operationId":"listInProgressRecruitmentEvents","tags":["Recruitment events"],"parameters":[{"$ref":"#/components/parameters/recruitmentEventInclude"}],"responses":{"200":{"description":"Success"}}}},"/recruitment_events/archived":{"get":{"summary":"Find archived recruitment events","description":"Return a list of the recruitment events that have been archived","operationId":"listArchivedRecruitmentEvents","tags":["Recruitment events"],"parameters":[{"$ref":"#/components/parameters/recruitmentEventInclude"}],"responses":{"200":{"description":"Success"}}}},"/jobs":{"get":{"summary":"List jobs","description":"List live jobs with options to paginate and return related categories.","operationId":"listJobs","tags":["Job"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"},{"$ref":"#/components/parameters/jobInclude"},{"$ref":"#/components/parameters/jobFilter"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"}}}},"/jobs/{jobId}":{"get":{"summary":"Find job by ID","description":"Returns a job and optionally includes related categories.","operationId":"getJob","tags":["Job"],"parameters":[{"in":"path","name":"jobId","description":"Job ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/jobInclude"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"}}}},"/lists":{"get":{"summary":"List a company's static lists","description":"List the static lists for a company with options to paginate.","operationId":"listLists","tags":["List"],"parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/perPage"}],"responses":{"200":{"description":"Success"},"401":{"description":"Invalid API credentials"}}}},"/lists/{listId}/candidates/{candidateId}":{"put":{"summary":"Add a candidate to a list","description":"Add a candidate to a static list","operationId":"addCandidateToList","tags":["List"],"parameters":[{"$ref":"#/components/parameters/listId"},{"$ref":"#/components/parameters/candidateId"}],"responses":{"200":{"description":"OK - Candidate was already on the list."},"201":{"description":"Created - Candidate was added to the list."},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}},"delete":{"summary":"Remove a candidate from a list","description":"Remove a candidate from a list","operationId":"removeCandidateFromList","tags":["List"],"parameters":[{"$ref":"#/components/parameters/listId"},{"$ref":"#/components/parameters/candidateId"}],"responses":{"204":{"description":"No content"},"401":{"description":"Invalid API credentials"},"404":{"description":"Not found"}}}}},"tags":[{"name":"Candidate","description":"Candidate operations"},{"name":"Recruitment events","description":"Recruitment events operations"},{"name":"Job","description":"Job operations"},{"name":"List","description":"List operations"}],"components":{"securitySchemes":{"HMAC":{"type":"http","scheme":"basic"}},"parameters":{"page":{"in":"query","name":"page","required":false,"schema":{"type":"integer"}},"perPage":{"in":"query","name":"per_page","required":false,"schema":{"type":"integer","example":5}},"cursor":{"in":"query","name":"cursor","description":"(Experimental). There is a limit to how many records you can fetch when combining a filter with numeric based pagination. Any attempt to request more than, for example, 10000 candidate records will result in a 400 HTTP response. To get past this limit, use cursor based pagination. Make the first GET call omitting the `page` parameter, and sending in an optional `per_page` parameter. The response should have a `next_cursor` value in the `meta` section of the response. Then set the `cursor` query parameter to this value on the subsequent GET call and repeat these steps until there are no more records to fetch.","required":false,"schema":{"type":"string"}},"candidateId":{"in":"path","name":"candidateId","description":"Candidate ID","required":true,"schema":{"type":"string"}},"jobApplicationId":{"in":"path","name":"jobApplicationId","description":"Job Application ID.","required":true,"schema":{"type":"string"}},"employmentId":{"in":"path","name":"employmentId","description":"Employment ID","required":true,"schema":{"type":"string"}},"educationId":{"in":"path","name":"educationId","description":"Education ID","required":true,"schema":{"type":"string"}},"candidateInclude":{"in":"query","name":"include","description":"Specify candidate relationships to include in the response","required":false,"type":"array","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["events","events.call_to_action","events.form_submission.fields","resumes","educations","employments","locations","lists","taggings","taggings.tag_source","jobs","job_applications","form_submissions","notes","project_template_stages","job_alert_subscriptions","job_alert_subscriptions.job_template_fields.options","first_touch_event","first_touch_event.traffic_source","last_touch_event","last_touch_event.traffic_source"]}}},"eventInclude":{"in":"query","name":"include","description":"Specify candidate relationships to include in the response","required":false,"type":"array","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["location","form_submission","form_submission.fields","call_to_action","traffic_source"]}}},"jobApplicationEventInclude":{"in":"query","name":"include","description":"Specify candidate events relationships to include in the response","required":false,"type":"array","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["location","form_submission","form_submission.fields","call_to_action","traffic_source"]}}},"candidateFilter":{"in":"query","name":"filter","description":"To filter candidates by `updated_at`, add the query parameters `filter[updated_at][(operator)]` e.g. `/candidates?filter[updated_at][lt]=2021-01-01T13:00:17`. Two operators are supported. `lt` meaning \"less than\", and `gte` meaning \"greater than or equal to\". They can be combined e.g. `/candidates?filter[updated_at][gte]=2020-01-01T00:00:00&filter[updated_at][lt]=2021-01-01T00:00:00`\n\nTo filter candidates by `email`, add the query parameters `filter[email][eq]` e.g. `/candidates?filter[email][eq]=name%40example.com`\n","required":false,"schema":{"type":"object","properties":{"updated_at":{"type":"object","properties":{"gte":{"type":"string","format":"date-time","example":"2022-05-01T00:00:00"}}}}},"style":"deepObject","explode":true},"eventFilter":{"in":"query","name":"filter","description":"Specify filtering to be applied to candidate events collection by property e.g kind - <small>/candidates/{candidate_id}/events?filter[kind]=cta</small>, created_at\n\nAccepted fields - kind:\n<small>view, cta, email, lifecycle, ats, user_modification, subscription, unsubscription, video, search, reapplication, consent_accepted, consent_rejected, chatbot_message, chatbot_fulfilment, chat_message, candidate_referral, application</small>\n\nAccepted fields - created_at:\n<small>gte (greater than or equal to), lte (less than or equal to)</small>\n","required":false,"schema":{"type":"object","properties":{"kind":{"type":"array","items":{"type":"string","example":"cta"}},"created_at":{"type":"object","properties":{"gte":{"type":"string","format":"date-time","example":"2021-01-01T13:00:17"}}}}},"style":"deepObject","explode":true},"jobApplicationEventFilter":{"in":"query","name":"filter","description":"Specify filtering to be applied to job application candidate events collection by property e.g kind - <small>/candidates/{candidate_id}/events?filter[kind]=ats</small>\n\nAccepted fields - kind:\n<small>view, cta, email, lifecycle, ats, user_modification, subscription, unsubscription, video, search, reapplication, consent_accepted, consent_rejected, chatbot_message, chatbot_fulfilment, chat_message, candidate_referral, application</small>\n\nAccepted fields - created_at:\n<small>gte (greater than or equal to), lte (less than or equal to)</small>\n","required":false,"schema":{"type":"object","properties":{"kind":{"type":"array","items":{"type":"string","example":"ats"}}}},"style":"deepObject","explode":true},"jobInclude":{"in":"query","name":"include","description":"Specify whether to include categories in the response","required":false,"type":"array","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["categories"]}}},"jobFilter":{"in":"query","name":"filter","description":"To filter jobs by free text search, add the query parameters `filter[q][eq]` e.g. `/jobs?filter[q][eq]=Engineer`. Free text search will perform a) exact matches on the job's ats id, requisition id, title, location postal code and state code b) wildcard matches on job title, description, location city, state and country c) phrase matches on the job summary and description. The following job component fields are also searched: departments, categories, category groups, location groups, employment types, levels, pay scales, role numbers, salary ranges. Finally job template fields are also searched.\n","required":false,"schema":{"type":"object","properties":{"q":{"type":"object","properties":{"eq":{"type":"string","example":"Engineer"}}}}},"style":"deepObject","explode":true},"recruitmentEventInclude":{"in":"query","name":"include","description":"Specify whether to include call_to_action in the response","required":false,"type":"array","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["call_to_actions","call_to_action.form_fields","call_to_action.form_fields.options"]}}},"listId":{"in":"path","name":"listId","description":"List ID","schema":{"type":"string"}}},"schemas":{"Candidate":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","example":"candidates"},"attributes":{"type":"object","properties":{"uid":{"type":"string","description":"Randomly generated unique identifier consisting of alphanumeric characters"},"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"},"links":{"type":"object","properties":{"self":{"properties":{"url":{"type":"string"}}},"mail_to":{"properties":{"url":{"type":"string"}}},"tel":{"properties":{"url":{"type":"string"}}},"linkedin":{"properties":{"url":{"type":"string"}}}}},"name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"tags":{"type":"array","items":{"type":"string","example":["Seed Data"]}},"skills":{"type":"array","items":{"type":"string","example":["business analysis","management","project delivery","requirements specifications"]}},"interaction_score":{"type":"number","minimum":0,"maximum":1,"description":"Metric for evaluating the engagement of a candidate"},"subscription_status":{"type":"string","enum":["unsubscribed","subscribed"]},"internal_candidate":{"type":"boolean"},"last_seen_at":{"$ref":"#/components/schemas/DateTime"},"manually_added":{"type":"boolean"},"first_seen_at":{"$ref":"#/components/schemas/DateTime"},"visit_count":{"type":"number"}}},"relationships":{"type":"object","description":"The id and event type of the association record","properties":{"resumes":{"description":"The resume documents uploaded by the candidate","example":{"id":"758c52893052ee2e5321464c42195a45","type":"candidate_files"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"educations":{"description":"The candidates educations i.e. High Schools, Universities, Courses","example":{"id":"b4e5ce4611e8c75b67e2dc77c8ff8151","type":"educations"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"employments":{"description":"The list of the candidate's previous employments","example":{"id":"9f1ae17985d136b64d0da3d6da27a876","type":"employments"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"locations":{"description":"The recorded locations of the candidate","example":{"id":"1061ab835973ccf1dbe59e22c9cb43af","type":"candidate_locations"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"events":{"description":"The list of events that the candidate has performed e.g. viewed job application, submitted application, replied to chat bot etc.","example":{"id":"f12c34190c66bf69e11b5aa009a895f2","type":"candidate_events"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"jobs":{"description":"All of the jobs associated with a candidate's activities e.g. the jobs that a candidate has viewed, applied for, received ATS statuses about etc.","example":{"id":"6e824334b40a67a20b6f0a57bd4a07b7","type":"jobs"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"job_applications":{"example":{"id":"832858ae82d285bf7ee5d492f52ac442","type":"job_applications"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"form_submissions":{"description":"The call to action form submissions","example":{"id":"0fb11199774d6d310ea2564e91688309","type":"form_submissions"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"lists":{"description":"The static lists to which the candidate belongs","example":{"id":"965f0d5d9203dddcd331af211dee2e72","type":"static_lists"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"notes":{"description":"The notes recorded of the candidate by an agent/recruiter","example":{"id":"a7ad00637f56c902b8d0805c0b765316","type":"notes"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"project_template_stages":{"description":"A list of projects template stages belonging to a candidate. It consists of a uid, and a stage name, and a project name","example":{"id":"82af9afefd7847536c98824631a15540","type":"project_template_stages"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"project_entries":{"description":"A list of the projects entries belonging to the candidate and project stage","example":{"id":"646410c1081d0e073444aeadb66712c3","type":"project_entries"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"job_alert_subscription":{"description":"The active job alert subscriptions that a candidate has. It consists of a uid and a query string covering the applicable departments, categories and locations","example":{"id":"7c399e48fce8a265474c34c276ae2eaf","type":"candidate_job_alert_subscriptions"},"allOf":[{"$ref":"#/components/schemas/DataType"},{"type":"object"}],"properties":{"relationships":{"type":"object","properties":{"job_template_fields":{"description":"The job template fields used by the job template field options in the job alert subscription","example":{"id":"0aa6ce414af42d93f17848e490b25cc5","type":"job_template_fields"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"job_template_field_options":{"description":"The job template field options used in the job alert subscription","example":{"id":"ecb82f19481239d3f67c1c04be92350a","type":"job_template_field_options"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}}}}}},"CandidateEvents":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","example":"candidate_events"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"},"kind":{"type":"string"},"ats":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"},"initial":{"type":"string"},"ats_status":{"type":"object","properties":{"name":{"type":"string"}}},"ats_secondary_status":{"type":"object","properties":{"name":{"type":"string"}}}}},"referrer":{"type":"object","properties":{"url":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"}}}}},"relationships":{"type":"object","properties":{"location":{"example":{"id":"a1652b9ced208297856e6be10cbbc7a2","type":"location"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"job":{"example":{"id":"4a31275f45c1beb4ae0e05be1c4d056c","type":"job"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"call_to_action":{"example":{"id":"7b67178deb5d385be7d9219006acd6c8","type":"call_to_action"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"form_submission":{"example":{"id":"1295cedda2ff144f3e5953d132c0feed","type":"form_submission"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"user_agent":{"example":{"id":"3466052224cbda8dd36559ef1db5540c","type":"user_agent"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"page":{"example":{"id":"8f3ba32c55cd6dfe4fabcaa384d2a8f4","type":"page"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"notes":{"example":{"id":"d7884fb683f3fed1bcffa30efd219a48","type":"notes"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"ats_status":{"example":{"id":"895e95741cb1fb96a43ee55ae006c8f8","type":"ats_status"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"ats_secondary_status":{"example":{"id":"1c53ff3f8590334959ab6f4306167a0e","type":"ats_secondary_status"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"traffic_source":{"example":{"id":"4f2e73329a0e8a285993756a947efe2e","type":"traffic_source"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}},"Job":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","example":"jobs"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"ats_uid":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"},"title":{"type":"string","example":"Sales Development Representative"},"title_with_locations_and_req":{"type":"string","description":"The title of the job, with locations and requisition id","example":"Sales Development Representative - Dublin, Ireland - Cork, Ireland (R12345)"},"summary":{"type":"string"},"description":{"type":"string"},"time_zone":{"type":"string"},"remote":{"type":"boolean"},"apply_url":{"type":"string","description":"The url link to the web page of the job application"},"opening_at":{"$ref":"#/components/schemas/DateTime"},"closing_at":{"$ref":"#/components/schemas/DateTime"},"status":{"type":"string","description":"The publication status of the job application page","example":"Live, Draft"},"payment_amount":{"type":"number","example":"30.00, 55,000"},"payment_frequency":{"type":"string","description":"The rate of payment for the associated payment amount","example":"Hourly, Annual"},"payment_currency_code":{"type":"string","description":"The international ISO 4217 standard code for the representation of the currency","example":"USD, EUR, AUD"}}},"relationships":{"type":"object","properties":{"categories":{"example":{"id":"52f620245abf2163560515862ea4e12b","type":"categories"},"allOf":[{"$ref":"#/components/schemas/DataType"}]},"locations":{"example":{"id":"1cce2cb6193742008cc53f01184793a0","type":"locations"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}},"List":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","example":"company_lists"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"},"name":{"type":"string","example":"Registered Interest"},"count":{"type":"integer","description":"The number of candidates in the list"}}}}},"DateTime":{"type":"object","properties":{"utc":{"type":"string","format":"date-time"},"epoch":{"type":"integer","format":"int64"},"ago":{"type":"string"},"local":{"type":"string","format":"date-time"},"local_epoch":{"type":"integer","format":"int64"}}},"DataType":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"JobTemplateField":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"display_name":{"type":"string"},"mapping_name":{"type":"string"}}},"relationships":{"type":"object","properties":{"job_template_field_options":{"description":"The job template field options belonging to the job template field","example":{"id":"c9624634e33051790e74c600e418b735","type":"job_template_field_options"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}},"JobTemplateFieldOption":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"name":{"type":"string"},"created_at":{"$ref":"#/components/schemas/DateTime"},"updated_at":{"$ref":"#/components/schemas/DateTime"}}},"relationships":{"type":"object","properties":{"job_template_fields":{"description":"The job template field that a job template field option belongs to","example":{"id":"b8b1ad0896d65612f7cb66c817cb0025","type":"job_template_fields"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}},"Tagging":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"uid":{"type":"string"},"name":{"type":"string"}}},"relationships":{"type":"object","properties":{"tag_source":{"description":"The source from which the tag was applied to the candidate","example":{"id":"1865a3120fb27976c6d7278c0c56dc4b","type":"tag_sources"},"allOf":[{"$ref":"#/components/schemas/DataType"}]}}}}}}},"security":[{"HMAC":[]}]}