{ "openapi": "3.1.0", "info": { "title": "Stardex API (Zapier)", "version": "1.0.0", "description": "Stardex Zapier integration endpoints." }, "servers": [ { "url": "https://api.stardex.ai", "description": "Production API server" } ], "tags": [], "components": { "schemas": { "ZapAddActivityBody": { "type": "object", "properties": { "activity_type": { "type": "string", "enum": [ "secondary_note", "meeting_note", "meeting_transcript", "email", "interview_note", "linkedin_message", "text_message", "candidate_summary", "linkedin_message_response", "call_note", "client_note" ] }, "note_content": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "linkedin_url": { "type": "string" }, "email": { "type": "string", "format": "email" }, "emails": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "phone": { "type": "string" }, "description": { "type": "string" }, "job_title": { "type": "string" }, "owner_email": { "type": "string", "description": "Email of the teammate this activity belongs to, for example the interviewer. When it matches an active teammate, they become the owner of the activity. Otherwise the activity is saved without an owner and shows this email so an admin can choose one." }, "source_tool": { "type": "string", "description": "Name of the tool the activity came from, for example Metaview." } }, "required": [ "activity_type", "note_content" ] }, "ZapAddActivityResponse": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "created_activities": { "type": "array", "items": { "type": "object", "properties": { "activity_id": { "type": "string" }, "person_id": { "type": [ "string", "null" ] }, "email": { "type": "string" } }, "required": [ "activity_id", "person_id" ] } }, "activity_type": { "type": "string" } }, "required": [ "created_activities", "activity_type" ] } }, "required": [ "success", "message", "data" ] }, "ZapAddPersonBody": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "linkedin_url": { "type": "string" }, "current_job_title": { "type": "string" }, "linkedin_location": { "type": "string" }, "company_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "emails": { "type": "string" }, "phone_number": { "type": "string" }, "phone_numbers": { "type": "string" }, "notes": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "client_name": { "type": "string" }, "client_id": { "type": "string" }, "external_source_id": { "type": "string" }, "enrich_record": { "type": "boolean" } }, "required": [ "name", "linkedin_url" ] }, "ZapAddPersonResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": [ "object", "null" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "linkedin_public_id": { "type": [ "string", "null" ] }, "current_job_title": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "linkedin_location": { "type": [ "string", "null" ] }, "emails": { "type": "array", "items": { "type": "object", "properties": { "contact_data_type": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "required": [ "contact_data_type", "value" ] } }, "phones": { "type": "array", "items": { "type": "object", "properties": { "contact_data_type": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "required": [ "contact_data_type", "value" ] } }, "candidate_id": { "type": [ "string", "null" ] }, "client_contact_id": { "type": [ "string", "null" ] }, "external_source_id": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "linkedin_public_id", "current_job_title", "company_name", "linkedin_location", "emails", "phones", "candidate_id", "client_contact_id", "external_source_id" ] } }, "required": [ "success", "message", "data" ] }, "ZapCandidateSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "candidate_id": { "type": "string" }, "candidate_job_status": { "type": "string" }, "person_id": { "type": "string" }, "person_full_name": { "type": "string" }, "person_current_title": { "type": "string" }, "person_current_company": { "type": "string" }, "person_linkedin_location": { "type": "string" }, "person_image_url": { "type": "string" }, "person_linkedin_url": { "type": "string" }, "person_recruiter_url_1": { "type": "string" }, "person_recruiter_url_2": { "type": "string" }, "person_linkedin_public_id": { "type": "string" }, "person_linkedin_recruiter_id_1": { "type": "string" }, "person_linkedin_recruiter_id_2": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_company": { "type": "string" }, "job_notes": { "type": "string" }, "sourced_by_team_member_name": { "type": "string" }, "person_owner": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_profile_link": { "type": "string" }, "resume_url": { "type": "string" }, "resume_filename": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" } }, "required": [ "id", "candidate_id", "candidate_job_status", "person_id", "person_full_name", "person_current_title", "person_current_company", "person_linkedin_location", "person_image_url", "person_linkedin_url", "person_recruiter_url_1", "person_recruiter_url_2", "person_linkedin_public_id", "person_linkedin_recruiter_id_1", "person_linkedin_recruiter_id_2", "job_id", "job_name", "job_company", "job_notes", "sourced_by_team_member_name", "person_owner", "created_at", "updated_at", "stardex_profile_link", "resume_url", "resume_filename", "custom_fields", "custom_fields_text" ] } }, "ZapJobArchivedSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_description": { "type": [ "string", "null" ] }, "job_company": { "type": [ "string", "null" ] }, "job_location": { "type": [ "string", "null" ] }, "job_primary_url": { "type": [ "string", "null" ] }, "job_work_model": { "type": [ "string", "null" ] }, "job_function": { "type": [ "string", "null" ] }, "job_status_id": { "type": [ "string", "null" ] }, "job_status_name": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "fee": { "type": [ "string", "null" ] }, "currency_code": { "type": [ "string", "null" ] }, "firm_commission_percent": { "type": [ "string", "null" ] }, "salary_details": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "candidate_start_date": { "type": [ "string", "null" ] }, "billing_contact_name": { "type": [ "string", "null" ] }, "billing_contact_email": { "type": [ "string", "null" ] }, "created_by_team_member_name": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_job_link": { "type": "string" }, "job_team_members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "team_member_id": { "type": "string" }, "team_member_name": { "type": [ "string", "null" ] }, "job_team_member_role_id": { "type": [ "string", "null" ] }, "job_team_member_role_name": { "type": [ "string", "null" ] } }, "required": [ "id", "team_member_id", "team_member_name", "job_team_member_role_id", "job_team_member_role_name" ] } }, "job_team_members_text": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" } }, "required": [ "id", "job_id", "job_name", "job_description", "job_company", "job_location", "job_primary_url", "job_work_model", "job_function", "job_status_id", "job_status_name", "is_archived", "fee", "currency_code", "firm_commission_percent", "salary_details", "open_date", "end_date", "candidate_start_date", "billing_contact_name", "billing_contact_email", "created_by_team_member_name", "created_at", "updated_at", "stardex_job_link", "job_team_members", "job_team_members_text", "custom_fields", "custom_fields_text" ] } }, "ZapJobCreatedSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_description": { "type": [ "string", "null" ] }, "job_company": { "type": [ "string", "null" ] }, "job_location": { "type": [ "string", "null" ] }, "job_primary_url": { "type": [ "string", "null" ] }, "job_work_model": { "type": [ "string", "null" ] }, "job_function": { "type": [ "string", "null" ] }, "job_status_id": { "type": [ "string", "null" ] }, "job_status_name": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "fee": { "type": [ "string", "null" ] }, "currency_code": { "type": [ "string", "null" ] }, "firm_commission_percent": { "type": [ "string", "null" ] }, "salary_details": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "candidate_start_date": { "type": [ "string", "null" ] }, "billing_contact_name": { "type": [ "string", "null" ] }, "billing_contact_email": { "type": [ "string", "null" ] }, "created_by_team_member_name": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_job_link": { "type": "string" }, "job_team_members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "team_member_id": { "type": "string" }, "team_member_name": { "type": [ "string", "null" ] }, "job_team_member_role_id": { "type": [ "string", "null" ] }, "job_team_member_role_name": { "type": [ "string", "null" ] } }, "required": [ "id", "team_member_id", "team_member_name", "job_team_member_role_id", "job_team_member_role_name" ] } }, "job_team_members_text": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" } }, "required": [ "id", "job_id", "job_name", "job_description", "job_company", "job_location", "job_primary_url", "job_work_model", "job_function", "job_status_id", "job_status_name", "is_archived", "fee", "currency_code", "firm_commission_percent", "salary_details", "open_date", "end_date", "candidate_start_date", "billing_contact_name", "billing_contact_email", "created_by_team_member_name", "created_at", "updated_at", "stardex_job_link", "job_team_members", "job_team_members_text", "custom_fields", "custom_fields_text" ] } }, "ZapJobDeletedSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_description": { "type": [ "string", "null" ] }, "job_company": { "type": [ "string", "null" ] }, "job_location": { "type": [ "string", "null" ] }, "job_primary_url": { "type": [ "string", "null" ] }, "job_work_model": { "type": [ "string", "null" ] }, "job_function": { "type": [ "string", "null" ] }, "job_status_id": { "type": [ "string", "null" ] }, "job_status_name": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "fee": { "type": [ "string", "null" ] }, "currency_code": { "type": [ "string", "null" ] }, "firm_commission_percent": { "type": [ "string", "null" ] }, "salary_details": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "candidate_start_date": { "type": [ "string", "null" ] }, "billing_contact_name": { "type": [ "string", "null" ] }, "billing_contact_email": { "type": [ "string", "null" ] }, "created_by_team_member_name": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_job_link": { "type": "string" }, "job_team_members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "team_member_id": { "type": "string" }, "team_member_name": { "type": [ "string", "null" ] }, "job_team_member_role_id": { "type": [ "string", "null" ] }, "job_team_member_role_name": { "type": [ "string", "null" ] } }, "required": [ "id", "team_member_id", "team_member_name", "job_team_member_role_id", "job_team_member_role_name" ] } }, "job_team_members_text": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" } }, "required": [ "id", "job_id", "job_name", "job_description", "job_company", "job_location", "job_primary_url", "job_work_model", "job_function", "job_status_id", "job_status_name", "is_archived", "fee", "currency_code", "firm_commission_percent", "salary_details", "open_date", "end_date", "candidate_start_date", "billing_contact_name", "billing_contact_email", "created_by_team_member_name", "created_at", "updated_at", "stardex_job_link", "job_team_members", "job_team_members_text", "custom_fields", "custom_fields_text" ] } }, "ZapJobStageChangeSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_description": { "type": [ "string", "null" ] }, "job_company": { "type": [ "string", "null" ] }, "job_location": { "type": [ "string", "null" ] }, "job_primary_url": { "type": [ "string", "null" ] }, "job_work_model": { "type": [ "string", "null" ] }, "job_function": { "type": [ "string", "null" ] }, "job_status_id": { "type": [ "string", "null" ] }, "job_status_name": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "fee": { "type": [ "string", "null" ] }, "currency_code": { "type": [ "string", "null" ] }, "firm_commission_percent": { "type": [ "string", "null" ] }, "salary_details": { "type": [ "string", "null" ] }, "open_date": { "type": [ "string", "null" ] }, "end_date": { "type": [ "string", "null" ] }, "candidate_start_date": { "type": [ "string", "null" ] }, "billing_contact_name": { "type": [ "string", "null" ] }, "billing_contact_email": { "type": [ "string", "null" ] }, "created_by_team_member_name": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_job_link": { "type": "string" }, "job_team_members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "team_member_id": { "type": "string" }, "team_member_name": { "type": [ "string", "null" ] }, "job_team_member_role_id": { "type": [ "string", "null" ] }, "job_team_member_role_name": { "type": [ "string", "null" ] } }, "required": [ "id", "team_member_id", "team_member_name", "job_team_member_role_id", "job_team_member_role_name" ] } }, "job_team_members_text": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" }, "from_stage_id": { "type": [ "string", "null" ] }, "from_stage_name": { "type": [ "string", "null" ] }, "to_stage_id": { "type": [ "string", "null" ] }, "to_stage_name": { "type": [ "string", "null" ] }, "stage_changed_at": { "type": [ "string", "null" ] }, "stage_changed_by_team_member_id": { "type": [ "string", "null" ] }, "stage_changed_by_team_member_name": { "type": [ "string", "null" ] } }, "required": [ "id", "job_id", "job_name", "job_description", "job_company", "job_location", "job_primary_url", "job_work_model", "job_function", "job_status_id", "job_status_name", "is_archived", "fee", "currency_code", "firm_commission_percent", "salary_details", "open_date", "end_date", "candidate_start_date", "billing_contact_name", "billing_contact_email", "created_by_team_member_name", "created_at", "updated_at", "stardex_job_link", "job_team_members", "job_team_members_text", "custom_fields", "custom_fields_text", "from_stage_id", "from_stage_name", "to_stage_id", "to_stage_name", "stage_changed_at", "stage_changed_by_team_member_id", "stage_changed_by_team_member_name" ] } }, "ZapListJobsResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ] } }, "ZapListPipelineStagesResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ] } }, "ZapStageChangeSampleResponse": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "candidate_id": { "type": "string" }, "candidate_job_status": { "type": "string" }, "person_id": { "type": "string" }, "person_full_name": { "type": "string" }, "person_current_title": { "type": "string" }, "person_current_company": { "type": "string" }, "person_linkedin_location": { "type": "string" }, "person_image_url": { "type": "string" }, "person_linkedin_url": { "type": "string" }, "person_recruiter_url_1": { "type": "string" }, "person_recruiter_url_2": { "type": "string" }, "person_linkedin_public_id": { "type": "string" }, "person_linkedin_recruiter_id_1": { "type": "string" }, "person_linkedin_recruiter_id_2": { "type": "string" }, "job_id": { "type": "string" }, "job_name": { "type": "string" }, "job_company": { "type": "string" }, "job_notes": { "type": "string" }, "sourced_by_team_member_name": { "type": "string" }, "person_owner": { "type": "string" }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "stardex_profile_link": { "type": "string" }, "resume_url": { "type": "string" }, "resume_filename": { "type": "string" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "value" ] } }, "custom_fields_text": { "type": "string" }, "from_stage_name": { "type": "string" }, "to_stage_name": { "type": "string" }, "from_job_pipeline_stage_id": { "type": [ "string", "null" ] }, "to_job_pipeline_stage_id": { "type": [ "string", "null" ] }, "stage_changed_at": { "type": "string" }, "stage_changed_by_team_member_id": { "type": [ "string", "null" ] }, "stage_changed_by_team_member_name": { "type": "string" } }, "required": [ "id", "candidate_id", "candidate_job_status", "person_id", "person_full_name", "person_current_title", "person_current_company", "person_linkedin_location", "person_image_url", "person_linkedin_url", "person_recruiter_url_1", "person_recruiter_url_2", "person_linkedin_public_id", "person_linkedin_recruiter_id_1", "person_linkedin_recruiter_id_2", "job_id", "job_name", "job_company", "job_notes", "sourced_by_team_member_name", "person_owner", "created_at", "updated_at", "stardex_profile_link", "resume_url", "resume_filename", "custom_fields", "custom_fields_text", "from_stage_name", "to_stage_name", "from_job_pipeline_stage_id", "to_job_pipeline_stage_id", "stage_changed_at", "stage_changed_by_team_member_id", "stage_changed_by_team_member_name" ] } }, "ZapUpdateStageBody": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid" }, "job_name": { "type": "string", "minLength": 1 }, "candidate_id": { "type": "string", "format": "uuid" }, "candidate_email": { "type": "string", "format": "email" }, "candidate_name": { "type": "string", "minLength": 1 }, "stage_id": { "type": "string", "minLength": 1 }, "stage_name": { "type": "string", "minLength": 1 } } }, "ZapUpdateStageResponse": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "message": { "type": "string", "enum": [ "Stage updated successfully" ] }, "data": { "type": "object", "properties": { "candidate_id": { "type": "string" }, "person_id": { "type": "string" }, "job_id": { "type": "string" }, "previous_stage_id": { "type": [ "string", "null" ] }, "new_stage_id": { "type": "string" } }, "required": [ "candidate_id", "person_id", "job_id", "previous_stage_id", "new_stage_id" ] } }, "required": [ "success", "message", "data" ] } }, "parameters": {}, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authenticate with a Bearer token: API key, OAuth token, or session token." } } }, "paths": { "/zapier/zap-add-activity": { "post": { "summary": "Zapier: Add Activity", "description": "Creates an activity with Zapier-tuned behavior including bulk email processing and LLM-based person matching.", "tags": [ "Zapier Endpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapAddActivityBody" } } } }, "responses": { "200": { "description": "Activity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapAddActivityResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-add-person": { "post": { "summary": "Zapier: Add Person", "description": "Creates a new person record tuned for Zapier payloads (comma-separated emails/phones supported).", "tags": [ "Zapier Endpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapAddPersonBody" } } } }, "responses": { "201": { "description": "Person added successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapAddPersonResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "409": { "description": "The person asked to be removed from your workspace and can't be added again", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapAddPersonResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-candidate-sample": { "get": { "summary": "Zapier: Get Candidate Sample", "description": "Returns the latest candidate data for Zapier trigger testing. Falls back to sample data if no candidates exist.", "tags": [ "Zapier Endpoints" ], "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "required": false, "name": "job_id", "in": "query" } ], "responses": { "200": { "description": "Candidate sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapCandidateSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-job-archived-sample": { "get": { "summary": "Zapier: Get Job Archived Sample", "description": "Returns the latest archived job data for Zapier trigger testing. Falls back to sample data if no archived jobs exist.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Job archived sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapJobArchivedSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-job-created-sample": { "get": { "summary": "Zapier: Get Job Created Sample", "description": "Returns the latest job data for Zapier trigger testing. Falls back to sample data if no jobs exist.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Job created sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapJobCreatedSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-job-deleted-sample": { "get": { "summary": "Zapier: Get Job Deleted Sample", "description": "Returns the latest deleted job data for Zapier trigger testing. Falls back to sample data if no deleted jobs exist.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Job deleted sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapJobDeletedSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-job-stage-change-sample": { "get": { "summary": "Zapier: Get Job Stage Change Sample", "description": "Returns sample job stage change data for Zapier trigger testing. Falls back to sample data if no matching job status changes exist.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Job stage change sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapJobStageChangeSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-list-jobs": { "get": { "summary": "Zapier: List Jobs", "description": "Returns a list of jobs for use in Zapier dynamic dropdowns.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Jobs retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapListJobsResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-list-pipeline-stages": { "get": { "summary": "Zapier: List Pipeline Stages", "description": "Returns a list of pipeline stages for use in Zapier dynamic dropdowns.", "tags": [ "Zapier Endpoints" ], "responses": { "200": { "description": "Pipeline stages retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapListPipelineStagesResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-stage-change-sample": { "get": { "summary": "Zapier: Get Stage Change Sample", "description": "Returns sample stage change data for Zapier trigger testing. Falls back to sample data if no matching candidates exist.", "tags": [ "Zapier Endpoints" ], "parameters": [ { "schema": { "type": "string" }, "required": false, "name": "pipeline_stage_ids", "in": "query" } ], "responses": { "200": { "description": "Stage change sample retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapStageChangeSampleResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } }, "/zapier/zap-update-stage": { "post": { "summary": "Zapier: Update Candidate Stage", "description": "Moves a candidate to a different stage. Accepts job and candidate by id/email/name and stage by id/name.", "tags": [ "Zapier Endpoints" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapUpdateStageBody" } } } }, "responses": { "200": { "description": "Stage updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZapUpdateStageResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ false ], "description": "Always false for error responses." }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\")." }, "message": { "type": "string", "description": "Human-readable error description." }, "details": { "type": "object", "additionalProperties": {}, "description": "Extra facts about the error when they help you fix it, such as a limit and when it resets." } }, "required": [ "code", "message" ] } }, "required": [ "success", "error" ] } } } } } } } }, "webhooks": {}, "security": [ { "bearerAuth": [] } ] }