# Loxo Documentation > Integrate with Loxo's Open API. Access comprehensive reference guides for managing candidate profiles, jobs, people data, and automated workflows. ## API Reference: Loxo API - [Loxo API](https://loxo.readme.io/reference/loxo-api.md) - /{agency_slug}/activity_types - [List Activity Types](https://loxo.readme.io/reference/activity_typesindex.md): List the agency activity types (categories for logging person and deal events, e.g. call, email, meeting), optionally scoped to a workflow. - /{agency_slug}/address_types - [List Address Types](https://loxo.readme.io/reference/address_typesindex.md): List the agency address types, used to categorize a company address (e.g. headquarters, branch office). - /{agency_slug}/agencies - [List Agencies](https://loxo.readme.io/reference/agenciesindex.md): List the current agency and its unchurned child agencies. - /{agency_slug}/bonus_payment_types - [List Bonus Payment Types](https://loxo.readme.io/reference/bonus_payment_typesindex.md): List the bonus payment types (e.g. lump sum, installments), used to categorize a job compensation bonus payment. - /{agency_slug}/bonus_types - [List Bonus Types](https://loxo.readme.io/reference/bonus_typesindex.md): List the bonus types (e.g. sign-on, performance, retention) used to categorize a job compensation bonus. - /{agency_slug}/campaigns - [List Email Campaigns](https://loxo.readme.io/reference/campaignsindex.md): List email campaigns for the agency, filterable by `job_id`. - /{agency_slug}/campaigns/{campaign_id}/campaign_recipients - [List Campaign Recipients](https://loxo.readme.io/reference/campaign_recipientsindex.md): List campaign recipients (people enrolled in email campaigns), filterable by `person_id`; available both scoped to a campaign and across all campaigns. - /{agency_slug}/campaigns/{campaign_id}/campaign_recipients/{id} - [Get Campaign Recipient](https://loxo.readme.io/reference/campaign_recipientsshow.md): Retrieve a single campaign recipient by ID. - [Update Campaign Recipient](https://loxo.readme.io/reference/campaign_recipientsupdate.md): Update a campaign recipient, such as pausing or unpausing them in the campaign. - /{agency_slug}/campaigns/{id} - [Get Email Campaign](https://loxo.readme.io/reference/campaignsshow.md): Retrieve a single email campaign by ID. - /{agency_slug}/campaigns/campaign_recipients - [List All Campaign Recipients](https://loxo.readme.io/reference/campaign_recipientsall_index.md): List campaign recipients (people enrolled in email campaigns), filterable by `person_id`; available both scoped to a campaign and across all campaigns. - /{agency_slug}/companies - [Create Company](https://loxo.readme.io/reference/companiescreate.md): Create a new company (account, employer, client, or organization) in the CRM. Set `name`, `url`, `description`, `culture`, fee terms, `owner_email`, `emails`, `phones`, and `addresses`. - [Search and List Companies](https://loxo.readme.io/reference/companiesindex.md): Search and list companies (accounts, employers) in the CRM. The `query` param is a Lucene query_string. Unqualified terms match `name`, `emails`, `phones`, `url`, `city`, `zip`, `addresses`,… - /{agency_slug}/companies/{company_id}/addresses - [List Company Addresses](https://loxo.readme.io/reference/company_addressesindex.md): List all addresses for a company. - [Add Company Address](https://loxo.readme.io/reference/company_addressescreate.md): Add a new address (location, office) to a company. Set `line1-3`, `city`, `state_id`, `zip`, `country_id`, and `address_type_id`. - /{agency_slug}/companies/{company_id}/addresses/{id} - [Get Company Address](https://loxo.readme.io/reference/company_addressesshow.md): Retrieve a single company address by ID. - [Delete Company Address](https://loxo.readme.io/reference/company_addressesdestroy.md): Permanently deletes a company address. - [Update Company Address](https://loxo.readme.io/reference/company_addressesupdate.md): Update an existing company address. Use to edit the street, city, state, zip, country, or address type. - /{agency_slug}/companies/{company_id}/documents - [Upload Company Document](https://loxo.readme.io/reference/company_documentscreate.md): Upload a new document (file attachment) to a company. - /{agency_slug}/companies/{company_id}/documents/{company_document_id}/download - [Download Company Document](https://loxo.readme.io/reference/company_documentsdownload.md): Download a company document (file attachment) by ID. Prefer the download_url on companies_show unless the raw bytes must come through this API. - /{agency_slug}/companies/{company_id}/documents/{id} - [Delete Company Document](https://loxo.readme.io/reference/company_documentsdestroy.md): Permanently deletes a company document. - /{agency_slug}/companies/{company_id}/emails - [Add Company Email Address](https://loxo.readme.io/reference/company_emailscreate.md): Add a new email address to a company. Set the email value, `email_type_id`, and position. - [List Company Email Addresses](https://loxo.readme.io/reference/company_emailsindex.md): List all email addresses for a company. - /{agency_slug}/companies/{company_id}/emails/{id} - [Get Company Email Address](https://loxo.readme.io/reference/company_emailsshow.md): Retrieve a single company email address by ID. - [Delete Company Email Address](https://loxo.readme.io/reference/company_emailsdestroy.md): Permanently deletes a company email address. - [Update Company Email Address](https://loxo.readme.io/reference/company_emailsupdate.md): Update an existing company email. Use to change the email address, type, or position. - /{agency_slug}/companies/{company_id}/people - [Search and List People at Company](https://loxo.readme.io/reference/company_peopleindex.md): List people (contacts, candidates) associated with a company (current, past, or pinned; the company is set by the path, not the `query`). The `query` param is a Lucene query_string: unqualified… - /{agency_slug}/companies/{company_id}/phones - [Add Company Phone Number](https://loxo.readme.io/reference/company_phonescreate.md): Add a new phone number to a company. Set the phone value, `phone_type_id`, and position. - [List Company Phone Numbers](https://loxo.readme.io/reference/company_phonesindex.md): List all phone numbers for a company. - /{agency_slug}/companies/{company_id}/phones/{id} - [Delete Company Phone Number](https://loxo.readme.io/reference/company_phonesdestroy.md): Permanently deletes a company phone number. - [Get Company Phone Number](https://loxo.readme.io/reference/company_phonesshow.md): Retrieve a single company phone number by ID. - [Update Company Phone Number](https://loxo.readme.io/reference/company_phonesupdate.md): Update an existing company phone number. Use to change the number, type, or position. - /{agency_slug}/companies/{id} - [Update Company](https://loxo.readme.io/reference/companiesupdate.md): Update an existing company. Use to rename, edit `url`, `description`, `culture`, fee terms, owner, `emails`, `phones`, or `addresses`. - [Get Company](https://loxo.readme.io/reference/companiesshow.md): Retrieve a single company by ID. Nested documents include download_url / download_url_expires_at (short-lived S3 URLs). Prefer those over company_documents_download. - /{agency_slug}/companies/{id}/merge - [Merge Company](https://loxo.readme.io/reference/companiesmerge.md): Merges the company given by `merge_company_id` into this company, combining their records (irreversible). Use to merge duplicate companies. - /{agency_slug}/company_global_statuses - [List Company Global Statuses](https://loxo.readme.io/reference/company_global_statusesindex.md): List the agency global statuses for companies (e.g. active, prospect, do not contact), used to set or filter a company status. - /{agency_slug}/company_types - [List Company Types](https://loxo.readme.io/reference/company_typesindex.md): List the agency company types (e.g. client, vendor, competitor), used to categorize and filter companies. - /{agency_slug}/compensation_types - [List Compensation Types](https://loxo.readme.io/reference/compensation_typesindex.md): List the compensation types (e.g. salary, hourly), used to categorize a person job profile compensation. - /{agency_slug}/countries - [Search and List Countries](https://loxo.readme.io/reference/countriesindex.md): List countries. The `query` param matches on name, code, or long_code (autocomplete-style matching, not Lucene). Supports paging via `page`/`per_page`. - /{agency_slug}/countries/{country_id}/states - [Search and List States in Country](https://loxo.readme.io/reference/statesindex.md): List states/provinces for a country (`country_id`, defaults to the United States). The `query` param matches on name or code (autocomplete-style matching, not Lucene). Supports paging via… - /{agency_slug}/countries/{country_id}/states/{state_id}/cities - [List Cities in State](https://loxo.readme.io/reference/citiesindex.md): List cities for a country and state, filterable by `country_id` and `state_id` (defaults to the United States and its states when omitted). Supports scroll pagination. - /{agency_slug}/currencies - [List Currencies](https://loxo.readme.io/reference/currenciesindex.md): List the supported currencies, used for job, placement, deal, and person compensation amounts. - /{agency_slug}/deal_workflows - [List Deal Workflows](https://loxo.readme.io/reference/deal_workflowsindex.md): List the deal pipeline workflows (deal stage configurations) available to the agency. - /{agency_slug}/deal_workflows/{id} - [Get Deal Workflow](https://loxo.readme.io/reference/deal_workflowsshow.md): Retrieve a single deal pipeline workflow by ID, including per-stage deal totals. - /{agency_slug}/deals - [Search and List Deals](https://loxo.readme.io/reference/dealsindex.md): Search and list deals (sales pipeline opportunities). The `query` param is a Lucene query_string. Unqualified terms match name, company_name, person_name, job_title, owned_by_name, deal_status_name,… - [Create Deal](https://loxo.readme.io/reference/dealscreate.md): Create a new deal (sales pipeline opportunity). Requires `name`, `amount`, `closes_at`, `workflow_id`, `pipeline_stage_id`, and `owner_email`; optionally links a company, person, and job. - /{agency_slug}/deals/{deal_id}/events - [Log Deal Event](https://loxo.readme.io/reference/deal_eventscreate.md): Log a new event (activity log entry) on a deal, such as a pipeline stage move. Records the `activity_type_id`, optional notes, and whether the move was dragged and dropped in the pipeline UI. - /{agency_slug}/deals/{id} - [Get Deal](https://loxo.readme.io/reference/dealsshow.md): Retrieve a single deal (sales pipeline opportunity) by ID. - [Update Deal](https://loxo.readme.io/reference/dealsupdate.md): Update an existing deal. Use to change the name, amount, close date, pipeline stage/workflow, owner, or linked company, person, or job. - /{agency_slug}/disability_statuses - [List Disability Statuses](https://loxo.readme.io/reference/disability_statusesindex.md): List the disability statuses used for a person diversity profile. - /{agency_slug}/diversity_types - [List Diversity Types](https://loxo.readme.io/reference/diversity_typesindex.md): List the agency diversity types used to categorize a person or candidate diversity profile. - /{agency_slug}/dynamic_fields - [List Dynamic Fields](https://loxo.readme.io/reference/dynamic_fieldsindex.md): List the custom (dynamic) fields configured for the agency, restricted to fields readable by the requesting user when applicable. - /{agency_slug}/dynamic_fields/{dynamic_field_id}/hierarchies - [Create Dynamic Field Hierarchy Node](https://loxo.readme.io/reference/hierarchiescreate.md): Create a new hierarchy node (a value option) under a dynamic field, optionally nested beneath a `parent_id`. - [List Dynamic Field Hierarchies](https://loxo.readme.io/reference/hierarchiesindex.md): List hierarchies (nested parent/child value options for hierarchical dynamic/custom fields) that the caller can read. - /{agency_slug}/dynamic_fields/{dynamic_field_id}/hierarchies/{id} - [Delete Dynamic Field Hierarchy Node](https://loxo.readme.io/reference/hierarchiesdestroy.md): Permanently deletes a hierarchy node. - [Update Dynamic Field Hierarchy Node](https://loxo.readme.io/reference/hierarchiesupdate.md): Update the name or parent_id of an existing hierarchy node. - [Get Dynamic Field Hierarchy Node](https://loxo.readme.io/reference/hierarchiesshow.md): Retrieve a single hierarchy node by ID. - /{agency_slug}/dynamic_fields/{id} - [Get Dynamic Field](https://loxo.readme.io/reference/dynamic_fieldsshow.md): Retrieve a single custom (dynamic) field by ID. - /{agency_slug}/education_types - [List Education Types](https://loxo.readme.io/reference/education_typesindex.md): List the education types (e.g. degree, certification) used on a person education profile. - /{agency_slug}/email_tracking - [List Email Tracking Events](https://loxo.readme.io/reference/email_trackingindex.md): List email tracking events (opened, clicked, downloaded, failed), filterable by `person_ids` and a created_at date range (`created_at_start`/`created_at_end`), with scroll pagination. - /{agency_slug}/email_types - [List Email Types](https://loxo.readme.io/reference/email_typesindex.md): List the agency email types (e.g. work, personal), used to categorize a person or company email address. - /{agency_slug}/equity_types - [List Equity Types](https://loxo.readme.io/reference/equity_typesindex.md): List the equity types (e.g. stock options, RSUs), used to categorize a job compensation equity component. - /{agency_slug}/ethnicities - [List Ethnicities](https://loxo.readme.io/reference/ethnicitiesindex.md): List the ethnicities used for a person diversity profile. - /{agency_slug}/fee_types - [List Fee Types](https://loxo.readme.io/reference/fee_typesindex.md): List the fee types (e.g. contingency, retained), used to categorize a job placement fee. - /{agency_slug}/form_templates - [List Form Templates](https://loxo.readme.io/reference/form_templatesindex.md): List form templates (reusable form definitions with questions) available to the agency, with scroll pagination. - /{agency_slug}/form_templates/{id} - [Get Form Template](https://loxo.readme.io/reference/form_templatesshow.md): Retrieve a single form template by ID, including its questions. - /{agency_slug}/forms - [Create Form Submission](https://loxo.readme.io/reference/formscreate.md): Create a new form (a completed instance of a form template) attached to a company, job, or person, with submitted answers. - [List Forms](https://loxo.readme.io/reference/formsindex.md): Search and list forms (custom form submissions attached to a company, job, or person). Filterable by `company_id`, `job_id`, and `person_id`, with scroll pagination. - /{agency_slug}/forms/{id} - [Delete Form Submission](https://loxo.readme.io/reference/formsdestroy.md): Permanently deletes a form. - [Update Form Submission](https://loxo.readme.io/reference/formsupdate.md): Update an existing form, including its title or submitted answers. - [Get Form Submission](https://loxo.readme.io/reference/formsshow.md): Retrieve a single form (custom form submission) by ID, including its answers. - /{agency_slug}/genders - [List Genders](https://loxo.readme.io/reference/gendersindex.md): List the genders used for a person profile. - /{agency_slug}/job_categories - [List Job Categories](https://loxo.readme.io/reference/job_categoriesindex.md): List available job categories for classifying job openings. - /{agency_slug}/job_contact_types - [List Job Contact Types](https://loxo.readme.io/reference/job_contact_typesindex.md): List available job contact types (roles for job contacts, e.g. hiring manager). - /{agency_slug}/job_listing_config - [Get Job Listing Configuration](https://loxo.readme.io/reference/job_listing_configindex.md): Retrieve the agency's job-board listing configuration (career-site display and application settings). - /{agency_slug}/job_owner_types - [List Job Owner Types](https://loxo.readme.io/reference/job_owner_typesindex.md): List available job owner types describing job ownership roles. - /{agency_slug}/job_statuses - [List Job Statuses](https://loxo.readme.io/reference/job_statusesindex.md): List available job statuses (e.g. open, closed, on hold). - /{agency_slug}/job_types - [List Job Types](https://loxo.readme.io/reference/job_typesindex.md): List available job types (e.g. full-time, contract, temporary). - /{agency_slug}/jobs - [Create Job](https://loxo.readme.io/reference/jobscreate.md): Create a new job. In Loxo, a job may also be called a search, search assignment, project, requisition, opening, vacancy, or role. Requires `job_type_id`, `raw_company_name`, and `title`; supports… - [Search and List Jobs](https://loxo.readme.io/reference/jobsindex.md): Search and list jobs. In Loxo, a job is the recruiting search, search assignment, project, requisition, opening, vacancy, or role being worked. The `query` param is a Lucene query_string.… - /{agency_slug}/jobs/{id} - [Update Job](https://loxo.readme.io/reference/jobsupdate.md): Update an existing job. In Loxo, a job may also be called a search, search assignment, project, requisition, opening, vacancy, or role. Use to rename the title, or change status, type, company,… - [Delete Job](https://loxo.readme.io/reference/jobsdestroy.md): Queues a job for deletion, also called a search, search assignment, project, requisition, opening, vacancy, or role. The job is removed by a background task shortly after. Fails if the job has… - [Get Job](https://loxo.readme.io/reference/jobsshow.md): Retrieve a single job by ID. In Loxo, a job may also be called a search, search assignment, project, requisition, opening, vacancy, or role. Nested documents include download_url /… - /{agency_slug}/jobs/{id}/merge - [Merge Jobs](https://loxo.readme.io/reference/jobsmerge.md): Merges the job given by `merge_job_id` into this job, combining their records (irreversible). Use to merge duplicate job openings. - /{agency_slug}/jobs/{job_id}/apply - [Submit Job Application](https://loxo.readme.io/reference/jobsapply.md): Submit a job application to a job opening on behalf of an applicant (name, email, resume, and answers). Use to apply a candidate to a published job. - /{agency_slug}/jobs/{job_id}/candidates - [Search and List Candidates Across Jobs](https://loxo.readme.io/reference/candidatesindex.md): Search candidates across the agency's hiring pipelines. Results include each candidate's person, job, and current workflow stage. Use the structured owner and stage filters for pipeline questions;… - [Search and List Candidates for Job](https://loxo.readme.io/reference/candidatesjob_index.md): Search candidates within one known job's hiring pipeline. Use candidates_index instead for agency-wide questions about candidate owners, job owners, job statuses, or workflow stages. - /{agency_slug}/jobs/{job_id}/candidates/{id} - [Get Job Candidate](https://loxo.readme.io/reference/candidatesshow.md): Retrieve a single candidate (a person entry in a job's hiring pipeline) by ID. To resolve a person to their name/profile, use people_show instead — this candidate ID is not a person ID.… - [Update Job Candidate](https://loxo.readme.io/reference/candidatesupdate.md): Update a candidate in a job's hiring pipeline. `csr_highlight` is Candidate Summary on the Candidate Report (also labeled Submission Summary in Submit Candidate). `highlights` is Comments on the… - [Remove Candidate from Job](https://loxo.readme.io/reference/candidatesdestroy.md): Permanently deletes a candidate, removing a person from a job's hiring pipeline. Does not delete the underlying person record. - /{agency_slug}/jobs/{job_id}/contacts - [List Job Contacts](https://loxo.readme.io/reference/job_contactsindex.md): List the client contacts (people at the hiring company) associated with a job opening. - [Add Job Contact](https://loxo.readme.io/reference/job_contactscreate.md): Add a client contact to a job opening. Associates an existing person (typically someone at the hiring company) with the job as a point of contact. - /{agency_slug}/jobs/{job_id}/contacts/{id} - [Remove Job Contact](https://loxo.readme.io/reference/job_contactsdestroy.md): Permanently deletes a job contact, removing the client contact link from the job opening. - [Update Job Contact](https://loxo.readme.io/reference/job_contactsupdate.md): Update an existing job contact. Use to change the linked person, contact type, or display position/ordering. - /{agency_slug}/jobs/{job_id}/documents - [Upload Job Document](https://loxo.readme.io/reference/job_documentscreate.md): Upload a document (file attachment) to a job opening. - /{agency_slug}/jobs/{job_id}/documents/{id} - [Delete Job Document](https://loxo.readme.io/reference/job_documentsdestroy.md): Permanently deletes a document attached to a job opening. - /{agency_slug}/jobs/{job_id}/documents/{job_document_id}/download - [Download Job Document](https://loxo.readme.io/reference/job_documentsdownload.md): Download a document file attached to a job opening. Prefer the download_url on jobs_show unless the raw bytes must come through this API. - /{agency_slug}/loxo_source/people - [Search Loxo Source People](https://loxo.readme.io/reference/loxo_source_peopleindex.md): Search the Loxo Source global directory of candidate profiles (names, titles, companies, skills, locations). The `query` param is required and supports free-text and boolean operators (AND, OR, NOT),… - /{agency_slug}/merges - [List Merge History](https://loxo.readme.io/reference/mergesindex.md): List merge history records (companies, jobs, or people that have been merged together). Filterable by `item_type`, `item_ids`, and `created_at` date range (`created_before`/`created_after`). - /{agency_slug}/people - [Create Person](https://loxo.readme.io/reference/peoplecreate.md): Create a new person (candidate, contact, or talent) in the CRM. Set name, emails, phones, current title/company, links, tags, and other profile fields. - [Search and List People](https://loxo.readme.io/reference/peopleindex.md): Search and list people (contacts, candidates, talent) in the CRM. The `query` param is a Lucene query_string. Unqualified terms match name, emails, phones, titles, current_title, current_company,… - /{agency_slug}/people/{id} - [Get Person](https://loxo.readme.io/reference/peopleshow.md): Retrieve a single person (contact, candidate, or talent) record by ID, with optional field selection. Includes description (intake notes / freeform recruiter notes about the person — users often call… - [Update Person](https://loxo.readme.io/reference/peopleupdate.md): Update an existing person (candidate, contact) record. Use to rename, or edit their name, title, current company, emails, phones, links, tags, or other profile fields. - /{agency_slug}/people/{id}/enrich - [Enrich Person](https://loxo.readme.io/reference/peopleenrich.md): Enrich a person record with additional data such as emails and phone numbers from Loxo enrichment sources. Consumes enrichment credits. - /{agency_slug}/people/{id}/merge - [Merge People](https://loxo.readme.io/reference/peoplemerge.md): Merges the person given by `merge_person_id` into this person, combining their records (irreversible). Use to merge duplicate people (candidates or contacts). - /{agency_slug}/people/{person_id}/documents - [Upload Person Document](https://loxo.readme.io/reference/person_documentscreate.md): Attach a document file to a person. Use to upload a file, contract, or other document to a person or candidate profile. Send the file as a multipart/form-data "document" part, or (for JSON requests,… - /{agency_slug}/people/{person_id}/documents/{id} - [Delete Person Document](https://loxo.readme.io/reference/person_documentsdestroy.md): Permanently deletes a document attached to a person. - /{agency_slug}/people/{person_id}/documents/{person_document_id}/download - [Download Person Document](https://loxo.readme.io/reference/person_documentsdownload.md): Download a document file attached to a person. Prefer the download_url on people_show unless the raw bytes must come through this API. - /{agency_slug}/people/{person_id}/education_profiles - [Add Person Education Profile](https://loxo.readme.io/reference/person_education_profilescreate.md): Add an education profile (school, degree, and graduation month/year) to a person. Use to record a candidate's academic history. - [List Person Education Profiles](https://loxo.readme.io/reference/person_education_profilesindex.md): List a person's education profiles (school, degree, and graduation history). - /{agency_slug}/people/{person_id}/education_profiles/{id} - [Update Person Education Profile](https://loxo.readme.io/reference/person_education_profilesupdate.md): Update an existing education profile for a person. Use to edit school, degree, graduation month/year, or education type. - [Delete Person Education Profile](https://loxo.readme.io/reference/person_education_profilesdestroy.md): Permanently deletes an education profile from a person's record. - [Get Person Education Profile](https://loxo.readme.io/reference/person_education_profilesshow.md): Retrieve a single education profile for a person by ID. - /{agency_slug}/people/{person_id}/emails - [Add Person Email Address](https://loxo.readme.io/reference/person_emailscreate.md): Add a new email address to a person record. Use to add a work, personal, or other contact email address. - [List Person Email Addresses](https://loxo.readme.io/reference/person_emailsindex.md): List the email addresses on file for a person. - /{agency_slug}/people/{person_id}/emails/{id} - [Delete Person Email Address](https://loxo.readme.io/reference/person_emailsdestroy.md): Permanently deletes an email address from a person record. - [Get Person Email Address](https://loxo.readme.io/reference/person_emailsshow.md): Retrieve a single email address for a person by ID. - [Update Person Email Address](https://loxo.readme.io/reference/person_emailsupdate.md): Update an existing email address on a person record, such as its value, email type, or position. - /{agency_slug}/people/{person_id}/job_profiles - [Add Person Job Profile](https://loxo.readme.io/reference/person_job_profilescreate.md): Add a job profile (employer, title, and employment dates) to a person. Use to record a candidate's work history or employment history. - [List Person Job Profiles](https://loxo.readme.io/reference/person_job_profilesindex.md): List a person's job profiles (work history entries: employer, title, and employment dates). - /{agency_slug}/people/{person_id}/job_profiles/{id} - [Update Person Job Profile](https://loxo.readme.io/reference/person_job_profilesupdate.md): Update an existing job profile for a person. Use to edit `title`, `company_name`, `company_id`, or employment start/end dates. - [Get Person Job Profile](https://loxo.readme.io/reference/person_job_profilesshow.md): Retrieve a single job profile (work history entry) for a person by ID. - [Delete Person Job Profile](https://loxo.readme.io/reference/person_job_profilesdestroy.md): Permanently deletes a job profile (work history entry) from a person's record. - /{agency_slug}/people/{person_id}/list_items - [List Person List Memberships](https://loxo.readme.io/reference/person_list_itemsindex.md): List a person's person-list memberships (`person_list_id` and position within each list). - [Add Person to List](https://loxo.readme.io/reference/person_list_itemscreate.md): Add a person to a person list. Use to associate a person with a list (`person_list_id`) and set its position within that list. - /{agency_slug}/people/{person_id}/list_items/{id} - [Remove Person from List](https://loxo.readme.io/reference/person_list_itemsdestroy.md): Permanently deletes a person-list membership, removing the person from that list. - [Get Person List Membership](https://loxo.readme.io/reference/person_list_itemsshow.md): Retrieve a single person-list membership (list item) for a person by ID. - [Update Person List Membership](https://loxo.readme.io/reference/person_list_itemsupdate.md): Update an existing person-list membership. Use to change the list (`person_list_id`) or position for a person. - /{agency_slug}/people/{person_id}/phones - [Add Person Phone Number](https://loxo.readme.io/reference/person_phonescreate.md): Add a new phone number to a person record. Use to add a mobile, work, home, or other contact phone number. - [List Person Phone Numbers](https://loxo.readme.io/reference/person_phonesindex.md): List the phone numbers on file for a person. - /{agency_slug}/people/{person_id}/phones/{id} - [Get Person Phone Number](https://loxo.readme.io/reference/person_phonesshow.md): Retrieve a single phone number for a person by ID. - [Update Person Phone Number](https://loxo.readme.io/reference/person_phonesupdate.md): Update an existing phone number on a person record, such as its value, phone type, or position. - [Delete Person Phone Number](https://loxo.readme.io/reference/person_phonesdestroy.md): Permanently deletes a phone number from a person record. - /{agency_slug}/people/{person_id}/resumes - [Upload Person Resume](https://loxo.readme.io/reference/resumescreate.md): Upload a resume file for a person. Use to add or replace a candidate resume or CV, with optional resume parsing. Send the file as a multipart/form-data "document" part, or (for JSON requests, eg.… - [List Person Resumes](https://loxo.readme.io/reference/resumesindex.md): List the resumes, CVs, and resume attachments on file for a person, newest first. Use this to discover resume IDs for resumes_show and resumes_download. Each entry includes download_url /… - /{agency_slug}/people/{person_id}/resumes/{id} - [Delete Person Resume](https://loxo.readme.io/reference/resumesdestroy.md): Permanently deletes a resume file for a person. - [Read Person Resume Text](https://loxo.readme.io/reference/resumesshow.md): Read a person's resume, CV, or resume attachment as extracted text. Use this when the recruiter asks about information contained in an attachment, including education, graduation dates, employment… - /{agency_slug}/people/{person_id}/resumes/{resume_id}/download - [Download Person Resume](https://loxo.readme.io/reference/resumesdownload.md): Download the original resume file bytes for a person. Prefer the download_url on resumes_show / people_show unless the raw bytes must come through this API. - /{agency_slug}/people/{person_id}/share - [Share Person Record](https://loxo.readme.io/reference/peopleshare.md): Grant a user temporary, time-limited access to selected fields on a person record (e.g. contact info) for a specific job. Use to share candidate or contact details with a colleague or external user.… - /{agency_slug}/people/{person_id}/sms_opt_ins - [Add Person SMS Consent Record](https://loxo.readme.io/reference/person_sms_opt_inscreate.md): Create an SMS opt-in or opt-out consent record for a person, tied to a phone number. - [List Person SMS Consent Records](https://loxo.readme.io/reference/person_sms_opt_insindex.md): List the SMS opt-in/opt-out consent records on file for a person. - /{agency_slug}/people/{person_id}/sms_opt_ins/{id} - [Get Person SMS Consent Record](https://loxo.readme.io/reference/person_sms_opt_insshow.md): Retrieve a single SMS opt-in/opt-out record for a person by ID. - /{agency_slug}/people/{person_id}/social_profiles - [Add Person Social Profile](https://loxo.readme.io/reference/person_social_profilescreate.md): Add a new social profile URL to a person record, such as a LinkedIn, Twitter/X, or other social media profile. - [List Person Social Profiles](https://loxo.readme.io/reference/person_social_profilesindex.md): List the social profiles (e.g. LinkedIn, Twitter/X) on file for a person. - /{agency_slug}/people/{person_id}/social_profiles/{id} - [Update Person Social Profile](https://loxo.readme.io/reference/person_social_profilesupdate.md): Update an existing social profile on a person record, such as its URL or social profile type. - [Get Person Social Profile](https://loxo.readme.io/reference/person_social_profilesshow.md): Retrieve a single social profile for a person by ID. - [Delete Person Social Profile](https://loxo.readme.io/reference/person_social_profilesdestroy.md): Permanently deletes a social profile from a person record. - /{agency_slug}/people/emails - [List Agency Person Email Addresses](https://loxo.readme.io/reference/agency_person_emailsindex.md): List person email addresses across the agency, filterable by `person_ids` and created/updated date ranges, sortable by created_at or updated_at, with scroll pagination. - /{agency_slug}/people/phones - [List Agency Person Phone Numbers](https://loxo.readme.io/reference/agency_person_phonesindex.md): List person phone numbers across the agency, filterable by `person_ids` and created/updated date ranges, sortable by `created_at` or `updated_at`, with scroll pagination. - /{agency_slug}/people/update_by_email - [Update Person by Email](https://loxo.readme.io/reference/peopleupdate_by_email.md): Update a person identified by email address rather than by ID. Use to edit profile fields when you have the email but not the Loxo person ID. - /{agency_slug}/person_events - [Search and List Person Events](https://loxo.readme.io/reference/person_eventsindex.md): Search and list person events (activity log entries: calls, emails, notes, meetings). The `query` param is a Lucene query_string. Unqualified terms match event notes only; field-qualified terms… - [Create Person Event](https://loxo.readme.io/reference/person_eventscreate.md): Create a person event (activity log entry: call, email, note, meeting, or interview) for a person, optionally tied to a job or company. Use to log recruiter activity, advance a candidate through… - /{agency_slug}/person_events/{id} - [Update Person Event](https://loxo.readme.io/reference/person_eventsupdate.md): Update an existing person event (activity log entry: call, email, note, or meeting). Use to edit notes, pinned status, or activity type. - [Get Person Event](https://loxo.readme.io/reference/person_eventsshow.md): Retrieve a single person event (activity log entry: call, email, note, or meeting) by ID. Phone call recordings appear in `documents` with download_url / download_url_expires_at (short-lived S3 URL).… - [Delete Person Event](https://loxo.readme.io/reference/person_eventsdestroy.md): Permanently deletes a person event (activity log entry: call, email, note, or meeting) from the activity log. - /{agency_slug}/person_events/{person_event_id}/call_recordings/{call_recording_id}/download - [Download Person Event Call Recording](https://loxo.readme.io/reference/call_recordingsdownload.md): Redirects to a short-lived S3 URL for the phone call recording attached to a person event (activity log entry), typically an outbound or inbound call. Prefer the download_url on person_events_show… - /{agency_slug}/person_events/{person_event_id}/documents - [Attach Document to Person Event](https://loxo.readme.io/reference/person_event_documentscreate.md): Attach a document file to a person event (activity log entry, e.g. a call, email, or meeting note). Use to upload a file associated with a logged activity. - /{agency_slug}/person_events/{person_event_id}/documents/{id} - [Delete Person Event Document](https://loxo.readme.io/reference/person_event_documentsdestroy.md): Permanently deletes a document attached to a person event (activity log entry). - /{agency_slug}/person_events/{person_event_id}/documents/{person_event_document_id}/download - [Download Person Event Document](https://loxo.readme.io/reference/person_event_documentsdownload.md): Download a document file attached to a person event (activity log entry, e.g. a call, email, or meeting note). Prefer the download_url on person_events_show unless the raw bytes must come through… - /{agency_slug}/person_global_statuses - [List Person Global Statuses](https://loxo.readme.io/reference/person_global_statusesindex.md): List available person global statuses (agency-wide status values for a person). - /{agency_slug}/person_lists - [List Person Lists](https://loxo.readme.io/reference/person_listsindex.md): List person lists (saved lists of people) visible to the current user, respecting private-list permissions. - /{agency_slug}/person_share_field_types - [List Person Share Field Types](https://loxo.readme.io/reference/person_share_field_typesindex.md): List available field types selectable when sharing a person record. - /{agency_slug}/person_types - [List Person Types](https://loxo.readme.io/reference/person_typesindex.md): List available person types (e.g. candidate, client contact). - /{agency_slug}/phone_types - [List Phone Types](https://loxo.readme.io/reference/phone_typesindex.md): List available phone types (e.g. mobile, work, home). - /{agency_slug}/placements - [Create Placement](https://loxo.readme.io/reference/placementscreate.md): Create a new placement for a hire, hired candidate, successful hire, or filled position. Requires `person_id`, `job_id`, and `start_date`; supports salary, bill/pay rate, fee, and split/notification… - [Search and List Placements](https://loxo.readme.io/reference/placementsindex.md): Search and list placements. In Loxo, a placement is a hire, hired candidate, successful hire, or filled position. The `query` param is a Lucene query_string. Unqualified terms match person_name,… - /{agency_slug}/placements/{id} - [Update Placement](https://loxo.readme.io/reference/placementsupdate.md): Update an existing placement (hire, hired candidate, successful hire, or filled position). Use to change dates, salary, bill/pay rate, fee, splits, or other placement fields. - [Delete Placement](https://loxo.readme.io/reference/placementsdestroy.md): Permanently deletes a placement (hire, hired candidate, successful hire, or filled position) record. - [Get Placement](https://loxo.readme.io/reference/placementsshow.md): Retrieve a single placement by ID. A placement is a hire, hired candidate, successful hire, or filled position in Loxo. - /{agency_slug}/pronouns - [List Pronouns](https://loxo.readme.io/reference/pronounsindex.md): List built-in pronoun options available for people. - /{agency_slug}/question_types - [List Question Types](https://loxo.readme.io/reference/question_typesindex.md): List available question types for scorecard and form questions. - /{agency_slug}/schedule_items - [List Schedule Items](https://loxo.readme.io/reference/schedule_itemsindex.md): List schedule items (meetings / calendar events, including interviews and AI Notetaker-recorded meetings). Filter with `person_id` to find meetings linked to a person as the primary person or as a… - /{agency_slug}/schedule_items/{id} - [Get Schedule Item](https://loxo.readme.io/reference/schedule_itemsshow.md): Retrieve a single schedule item (meeting / calendar event) by ID, including AI Notetaker content when available: transcript_text and outline_text (plain text for reading/quoting), plus… - /{agency_slug}/schedule_items/{schedule_item_id}/recording/download - [Download Schedule Item Recording](https://loxo.readme.io/reference/schedule_item_recordingsdownload.md): Redirects to a short-lived S3 URL for the audio/video recording file of a schedule item (meeting / calendar event), including AI Notetaker recordings. Prefer recording_download_url on… - /{agency_slug}/scorecards - [List Scorecards](https://loxo.readme.io/reference/scorecardsindex.md): List scorecards (candidate interview feedback and ratings). Filterable by `person_id` and `job_id`, with page or `scroll_id` pagination. - [Create Scorecard](https://loxo.readme.io/reference/scorecardscreate.md): Create a new scorecard (interview feedback, score, and recommendation) for a person, optionally tied to a job, scored attributes, and prerequisite answer snapshots. - /{agency_slug}/scorecards/{id} - [Delete Scorecard](https://loxo.readme.io/reference/scorecardsdestroy.md): Permanently deletes a scorecard. - [Update Scorecard](https://loxo.readme.io/reference/scorecardsupdate.md): Update an existing scorecard, including its summary, recommendation, or scored attributes. Prerequisite answers are partial updates: include id to edit an answer or id and _destroy to delete it.… - [Get Scorecard](https://loxo.readme.io/reference/scorecardsshow.md): Retrieve a single scorecard by ID. - /{agency_slug}/scorecards/scorecard_recommendation_types - [List Scorecard Recommendation Types](https://loxo.readme.io/reference/scorecard_recommendation_typesindex.md): List available scorecard recommendation types (e.g. hire, no hire). - /{agency_slug}/scorecards/scorecard_templates - [Create Scorecard Template](https://loxo.readme.io/reference/scorecard_templatescreate.md): Create a new scorecard template (a reusable set of rating attributes for interview feedback), optionally scoped to a job. Nested scorecard_template_prerequisites may include… - [List Scorecard Templates](https://loxo.readme.io/reference/scorecard_templatesindex.md): List scorecard templates (reusable sets of scorecard rating attributes). Filterable by `job_id`, with scroll pagination. - /{agency_slug}/scorecards/scorecard_templates/{id} - [Update Scorecard Template](https://loxo.readme.io/reference/scorecard_templatesupdate.md): Update an existing scorecard template, including its name, default flag, rating attributes, or prerequisite definitions. Prerequisites and their options are partial updates: include id to edit a… - [Delete Scorecard Template](https://loxo.readme.io/reference/scorecard_templatesdestroy.md): Permanently deletes a scorecard template. - [Get Scorecard Template](https://loxo.readme.io/reference/scorecard_templatesshow.md): Retrieve a single scorecard template by ID. - /{agency_slug}/scorecards/scorecard_types - [List Scorecard Types](https://loxo.readme.io/reference/scorecard_typesindex.md): List available scorecard types for categorizing scorecards. - /{agency_slug}/scorecards/scorecard_visibility_types - [List Scorecard Visibility Types](https://loxo.readme.io/reference/scorecard_visibility_typesindex.md): List available scorecard visibility types controlling who can view a scorecard. - /{agency_slug}/seniority_levels - [List Seniority Levels](https://loxo.readme.io/reference/seniority_levelsindex.md): List available seniority levels for candidates and jobs. - /{agency_slug}/sms - [List SMS Messages](https://loxo.readme.io/reference/smsindex.md): List SMS text messages sent or received by the agency. Filterable by `created_at_start` and `created_at_end`, with scroll pagination. - [Send SMS Message](https://loxo.readme.io/reference/smscreate.md): Send a new SMS text message to a person from an agency or user phone number. - /{agency_slug}/sms/{id} - [Get SMS Message](https://loxo.readme.io/reference/smsshow.md): Retrieve a single SMS text message by ID. - /{agency_slug}/social_profile_types - [List Social Profile Types](https://loxo.readme.io/reference/social_profile_typesindex.md): List available social profile types (e.g. LinkedIn, Twitter) for a person. - /{agency_slug}/source_types - [Create Source Type](https://loxo.readme.io/reference/source_typescreate.md): Create a new source type (a label for tracking where candidates or companies originated). - [List Source Types](https://loxo.readme.io/reference/source_typesindex.md): List source types (labels for how a candidate or company was sourced, e.g. referral, job board) configured for the agency, with after_id pagination. - /{agency_slug}/source_types/{id} - [Delete Source Type](https://loxo.readme.io/reference/source_typesdestroy.md): Permanently deletes a source type. Built-in source types cannot be deleted. - [Get Source Type](https://loxo.readme.io/reference/source_typesshow.md): Retrieve a single source type by ID. - [Update Source Type](https://loxo.readme.io/reference/source_typesupdate.md): Update an existing source type, including its name, active, publishable, or hidden flags. - /{agency_slug}/users - [Search and List Agency Users](https://loxo.readme.io/reference/usersindex.md): List the users belonging to the current agency. Pass `name` to resolve a specific user (e.g. a recruiter mentioned by name) by a case-insensitive substring match against their name or email, instead… - /{agency_slug}/users/me - [Get Current User](https://loxo.readme.io/reference/usersme.md): Return the identity (user ID, name, and email) of the user you are currently talking to. Call this whenever you need to know who is asking — for example to answer a question about "I", "me", or "my… - /{agency_slug}/veteran_statuses - [List Veteran Statuses](https://loxo.readme.io/reference/veteran_statusesindex.md): List available veteran statuses for classifying people. - /{agency_slug}/webhooks - [List Webhooks](https://loxo.readme.io/reference/webhooksindex.md): List webhooks configured for the agency (API-key authentication only). - [Create Webhook](https://loxo.readme.io/reference/webhookscreate.md): Create a new webhook subscription (API-key authentication only). Registers a URL to receive event callbacks for a given `item_type` and `action`. - /{agency_slug}/webhooks/{id} - [Delete Webhook](https://loxo.readme.io/reference/webhooksdestroy.md): Permanently deletes a webhook (API-key authentication only). - [Update Webhook](https://loxo.readme.io/reference/webhooksupdate.md): Update an existing webhook subscription (API-key authentication only), such as its URL, item_type, or action. - [Get Webhook](https://loxo.readme.io/reference/webhooksshow.md): Retrieve a single webhook by ID (API-key authentication only). - /{agency_slug}/workflow_stages - [List Workflow Stages](https://loxo.readme.io/reference/workflow_stagesindex.md): List the stages of a workflow (defaults to the job pipeline workflow, or a specific workflow via `workflow_id`). - /{agency_slug}/workflows - [List Workflows](https://loxo.readme.io/reference/workflowsindex.md): List the agency workflows (pipeline stage configurations for jobs).