### Get Users List Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant This is an example of a successful response when retrieving a list of users. It includes details for a single user. ```json [ { "id": "z5G7h3l6a1kMvyS65NP3c6JXmItyVpouoBm3SZdejFg=", "first_name": "John", "middle_name": "", "last_name": "Doe", "display_name": "John Doe", "nick_name": "John", "email_id": "johndoe@ceipal.com", "contact_number": "5855422728", "office_no": "5855422728", "status": "Active", "reporting_to": 0, "business_unit_id": 1, "created": "2022-09-18 23:19:46", "joining_date": "2022-09-11", "accessible_bu": "1", "role": "Administrator", "team_name": "John's Team", "admin_privilege": "No", "timezone": "Asia/Kolkata" } ] ``` -------------------------------- ### Get User Details Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant This is an example of a successful response when retrieving details for a specific user. ```json { "id": "z5G7h3l6a1kMk8XR6g4J0Yc5M5HYXes=", "first_name": "John", "middle_name": "", "last_name": "Doe", "display_name": "John Doe", "nick_name": "John", "email_id": "johndoe@ceipal.com", "contact_number": "5855030090", "office_no": "5855422728", "status": "Active", "reporting_to": 0, "business_unit_id": 1, "created": "2014-08-28 02:20:15", "joining_date": "2017-02-03", "accessible_bu": "1, 2", "role": "Administrator", "team_name": "John's Team", "admin_privilege": "No", "timezone": "Asia/Kolkata" } ``` -------------------------------- ### Retrieve Leads List via cURL Source: https://developer.ceipal.com/ceipal-ats-version-one/leads Example request to fetch the list of leads using the GET /v1/getLeadsList endpoint. ```bash 1curl --location 'https://api.ceipal.com/v1/getLeadsList' \ 2--header 'Content-Type: application/json' \ 3--header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### Retrieve Leads List via cURL Source: https://developer.ceipal.com/ceipal-ats-version-one/applicants Example request to fetch the list of leads using the GET /v1/getLeadsList endpoint. ```bash 1curl --location 'https://api.ceipal.com/v1/getLeadsList' \ 2--header 'Content-Type: application/json' \ 3--header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### Lead Details Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Example JSON response structure for a successful lead details retrieval request. ```json { "id": "z5G7h3l6a1kMvykA1ys1oDZyGH9qlAUa1E=", "business_unit_id": 1, "name": "Test345 Solutions", "country": "United States", "state": "Kowloon city", "city": "New Jersey", "zipcode": "968574", "website": "https://wwwt80980970orp.com", "ownership": "z5G7h3l6a1kMNP3c7IR4bb9gZS6U44tnvwbGXk=", "created_by": "z5G7h3l3c3QylsJA2pfy8ey8BJWTc4E=", "created_at": "2025-04-23 04:11:31", "industry_type": "", "lead_status": "Pre-Qualified", "updated_at": "2025-04-23 04:11:31", "updated_by": "z5G7h3l6a1kMv3QylsJA2pfy8ey8BJWTc4E=", "modified_by": "z5G7h3l6a1kMvySsJA2pfy8ey8BJWTc4E=", "contacts": [], "created_on": "2025-04-23 04:11:31", "modified_on": "2025-04-23 04:11:31" } ``` -------------------------------- ### Client List Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Example of a successful response when retrieving a list of clients. The response is a JSON array of client objects. ```json [ { "id": "z5G7h3l6a1kMvyS65NP3c-UBBjV4-6H2zYukUegwENQ=", "name": "Acme Services", "country": "United States", "state": "New York", "city": "Rochester", "zipcode": "14606", "website": "https://acme.com", "ownership": "z5G7h3l6a1kNP3cxiYkQqiv_JewAbSl3MsR3Y=", "status": "Active", "category": "Premium", "created_by": "z5G7h3l6a1kNP3cxiYkQqiv_JewAbSl3MsR3Y=", "created_at": "2022-09-26 13:52:59", "updated_at": "2022-09-26 13:52:59", "industry_exp": "Banking - Financial Services", "primary_business_unit": 1, "accessible_business_units": "1, 2" } ] ``` -------------------------------- ### Authentication Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant This is an example of a successful response when creating an authentication token, containing the access token and refresh token. ```JSON { "access_token": "eyJ0eXAiOi0W5w-OEv6UX9K2MjT9WCIxo", "refresh_token": "eyJn8EE6YcLBUXkC_36KCorUlaOnERpbjM" } ``` -------------------------------- ### Vendor List Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Example JSON response structure for a successful vendor list retrieval request. ```json { "id": "z5G7h3l6a1kMvyS65NBiuY8yx7NekplPWRNx1A=", "vendor_name": "Subhash Bathula", "contact_number": "8909090909", "website": "www.ceepal.com", "address": "221", "country": "India", "state": "Telangana", "city": "State Bank Oyderabad - 500001", "zipcode": "500001", "primary_owner": "z5G7h3vyS65NP3czTml5OncqLKwfytPS99OZk=", "ownership": "z5G7h3l6a1S65NP3cz-pFk0dmdUcQdGQ7L6fQNU=", "created_by": "z5G7h3l6ajP8u3gEV2lz7uqpeBd7QnU=", "created": "2025-04-19 03:02:15", "modified": "2025-04-21 11:39:34", "primary_business_unit": 1, "accessible_business_units": "1", "modified_by": "z5G7h3l6a1kMS65NP3c_38u3gEV2lz7uqpeBd7QnU=" } ``` -------------------------------- ### Applicant Sources Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/master-data/applicant-status Example JSON response for the getSourcesList endpoint, showing a list of sources with their IDs and names. ```json [ { "id": 161, "name": "Dice" }, { "id": 162, "name": "Monster" } ] ``` -------------------------------- ### Retrieve Bench Details Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Example JSON response body containing standard applicant bench fields. ```json { "bench_id": "z5G7h3l6a1kMvyS65NP3c64", "consultant_name": "John Doe", "firstname": "John", "lastname": "Doe", "middlename": "", "email": "john.doe@gmail.com", "email_address_1": "john.doe1@gmail.com", "other_phone": "585-500-0000", "address": "", "city": "Rochester", "state": "NY", "country": "United States", "mobile_number": "585-500-0000", "modify_date": "2023-01-08 10:44:36", "skills": "", "modified_by": "z5G7h3l6a1kMvyS65NP3cw05_c", "created_by": "z5G7h3l6a1kMvyS65NP3cw05_c", "created_at": "2023-01-08 15:41:01", "phone": "585-500-0002", "alternative_phone": "585-500-0002", "primary_skill": "Automation, Jenkins", "work_authorization": "4", "bench_details": { "bench_status": "Active Bench", "bench_age": "278 Days", "marketing_name": "", "sales_team_member": "", "employment_type": "", "location_constraint": "", "availability": "", "priority": "", "account_manager": "", "pay_type": "Percentage", "employee_percentage": "", "lead_type": "", "lead_generated_by": "", "additional_notifiers": "", "comments": "" }, "source": "", "resume_path": "" } ``` ```json { "bench_id": "z5G7h3l6a1kMvyS65NP3c64E8sAZ63IcjpzCnxvZxBQ=", "consultant_name": "Neer K", "firstname": "Neer", "lastname": "K", "middlename": "", "email": "shaheena.s+7890@ceipal.com", "email_address_1": "", "other_phone": "", "address": "", "city": "", "state": "", "country": "United States", "mobile_number": "234567", "modify_date": "2023-01-08 10:44:36", "skills": "", "modified_by": "0", "created_by": "z5G7h3l6a1kMvyS65NP3cw05_cKCu6YJ18ZfsrAwCDs=", "created_at": "2023-01-08 15:41:01", "phone": "", "alternative_phone": "", "primary_skill": "Automation Analyst", "work_authorization": "", "bench_details": { "bench_status": "Active Bench", "bench_age": "278 Days", "marketing_name": "", "sales_team_member": null, "employment_type": "", "location_constraint": "", "availability": "", "priority": "", "account_manager": null, "pay_type": "Percentage", "employee_percentage": null, "lead_type": "", "lead_generated_by": null, "additional_notifiers": "", "comments": "" }, "source": "", "resume_path": "" } ``` -------------------------------- ### Get Bench Details API Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/leads This JSON object shows a typical response for the getBenchDetails API endpoint. It contains comprehensive applicant and bench-related data. ```json { "bench_id": "z5G7h3l6a1kMvyS65NP3c64E8sAZ63IcjpzCnxvZxBQ=", "consultant_name": "Neer K", "firstname": "Neer", "lastname": "K", "middlename": "", "email": "shaheena.s+7890@ceipal.com", "email_address_1": "", "other_phone": "", "address": "", "city": "", "state": "", "country": "United States", "mobile_number": "234567", "modify_date": "2023-01-08 10:44:36", "skills": "", "modified_by": "0", "created_by": "z5G7h3l6a1kMvyS65NP3cw05_cKCu6YJ18ZfsrAwCDs=", "created_at": "2023-01-08 15:41:01", "phone": "", "alternative_phone": "", "primary_skill": "Automation Analyst", "work_authorization": "", "bench_details": { "bench_status": "Active Bench", "bench_age": "278 Days", "marketing_name": "", "sales_team_member": null, "employment_type": "", "location_constraint": "", "availability": "", "priority": "", "account_manager": null, "pay_type": "Percentage", "employee_percentage": null, "lead_type": "", "lead_generated_by": null, "additional_notifiers": "", "comments": "" }, "source": "", "resume_path": "" } ``` -------------------------------- ### Job Posting Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Example JSON response for the getJobPostingsList endpoint, detailing a single job posting. ```json { "id": "z5G7h3l6a1kMvyS65NP3c5dHbAoMlh_4ug5_SBU63j0=", "company": null, "remote_opportunities": "No", "city": "Rochester", "position_title": "TEstingfor Java", "public_job_desc": "", "job_code": "MKG2468", "modified": "2025-04-24 09:22:01", "post_on_careerportal": "Yes", "closing_date": "2025-04-30 21:00:00", "job_start_date": "2025-04-24", "job_end_date": null, "job_status": "ACTIVE", "created": "2025-04-24 09:22:00", "pay_rates": [ { "pay_rate_currency": "USD", "pay_rate": "N/A", "pay_rate_pay_frequency_type": "Monthly", "pay_rate_employment_type": "B2b", "min_pay_rate": "", "max_pay_rate": "N/A" } ], "posted_by": "z5G7h3l6a1kMvyS65NP3cy6f7U8eFeKeM=", "modified_by": "z5G7h3l6a1kMvyS65NP3cy6fv3U8eFeKeM=", "assigned_recruiter": "", "sales_manager": null, "primary_recruiter": null, "business_unit_id": 1, "currency": "USD", "employment_type": "B2b", "is_recycle": null, "public_job_title": "", "priority": "", "state": "New York", "requisition_description": "
Alex1 SufechnsenAccounts Manager1001-1001alex.s@ceipal.com
", "posted": "Today" } ``` -------------------------------- ### Retrieve Applicants List Request Source: https://developer.ceipal.com/ceipal-ats-version-one/client-details Example cURL request to fetch the list of applicants using the GET method. ```bash 1curl --location 'https://api.ceipal.com/v1/getApplicantsList' \ 2--header 'Content-Type: application/json' \ 3--header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### Countries Response Example Source: https://developer.ceipal.com/ceipal-ats-version-one/master-data/applicant-status Example JSON response for the getCountriesList endpoint, showing a list of countries with detailed information. ```json [ { "id": 840, "name": "United States", "continent": "NA", "currency": "Dollar", "iso_currency_code": "USD", "phone_prefix": "1", "iso": "US" }, { "id": 356, "name": "India", "continent": "AS", "currency": "Rupee", "iso_currency_code": "INR", "phone_prefix": "91", "iso": "IN" } ] ``` -------------------------------- ### Get List of Clients Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant Use this endpoint to retrieve a list of all clients. Requires an Authorization header. ```bash curl --location 'https://api.ceipal.com/v1/getClientsList' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### cURL Request to Get Bench Details Source: https://developer.ceipal.com/ceipal-ats-version-one/leads This cURL command demonstrates how to request detailed bench information. Ensure you include your authorization token and the required benchId in the query parameters. ```bash curl --location 'https://api.ceipal.com/v1/getBenchDetails/?benchId=z5G7h3l6a1kMvyS65NP3c' --header 'Content-Type: application/json' --header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### Example Client Account Response Source: https://developer.ceipal.com/ceipal-ats-version-one/create-applicant This JSON object represents a successful response when retrieving a client account. It includes detailed information about the client and their contacts. ```json { "id": "z5G7h3l6a1kMvyS65NP3c-UBBjV4-6H2zYukUegwENQ=", "name": "Acme Services", "status": "Active", "category": "Premium", "country": "United States", "state": "New York", "city": "Rochester", "ownership": "z5G7h3l6a1P3cxiYkQqiv_JewAbSl3MsR3Y=", "website": "https://acme.com", "created_by": "z5G7h3l6a1k3cxiYkQqiv_JewAbSl3MsR3Y=", "created_at": "2022-09-26 13:52:59", "primary_business_unit": 1, "accessible_business_units": "0", "contacts": [ { "contact_first_name": "John", "contact_last_name": "Doe", "designation": "CFO", "extension": "", "mobile_no": "5855422728", "contact_number": "5855030100", "email_id": "john.doe@acme.com", "owner": "z5G7h3l63cxiYkQqiv_JewAbSl3MsR3Y=", "primary_owner": "z5G7h3l6a1kMxgn8SsygbGEXh68fzzSdyo=", "address2": "", "address1": "687 Lee Rd Suite 208A", "country": "United States", "state": "New York", "city": "Rochester", "zip_code": "14606", "client_contact_status": "New Lead" }, { "contact_first_name": "Steve", "contact_last_name": "Rehburg", "designation": "Design Steward", "extension": "", "mobile_no": "5855472738", "contact_number": "5855422728", "email_id": "steve.rehburg@acme.com", "owner": "z5G7h3l6a1kMvyS6YkQqiv_JewAbSl3MsR3Y=", "primary_owner": "z5G7h3l6a1cxiYkQqiv_JewAbSl3MsR3Y=", "address2": "", "address1": "687 Lee Rd Suite 208A", "country": "United States", "state": "New York", "city": "Rochester", "zip_code": "14606", "client_contact_status": "Negotiating" } ], "industry_type": "Banking - Financial Services", "accounts": [ { "contact_person_name": "John Quinn", "contact_person_number": "5855422728", "email": "john.quinn@acme.com", "created_by": "z5G7h3l6a1kMiYkQqiv_JewAbSl3MsR3Y=", "modified_by": "z5G7h3l6a1kcyYz6UoA2Vpo58J8oHftWtM=" }, { "contact_person_name": "Wendy M", "contact_person_number": "5855412929", "email": "wendy.m@acme.com", "created_by": "z5G7h3l6aP3cxiYkQqiv_JewAbSl3MsR3Y=", "modified_by": "z5G7h3l6a1P3cyYz6UoA2Vpo58J8oHftWtM=" } ] } ``` -------------------------------- ### Example API Response for Placement Source: https://developer.ceipal.com/ceipal-ats-version-one/client-details This JSON object represents a successful API response for a placement, detailing various aspects of the job placement, payment, and associated parties. ```json { "id": "z5G7h3l6a1kMvyS65NP3cwGfK6jdYOJiCWBTTbN2FmY=", "job_id": "z5G7h3l6a1kMva5bt_O2Pmpm5TqZ0Ayks=", "placement_id": "PLC-833", "created_by": "z5G7h3l6a1kMvyS65NPqiv_JewAbSl3MsR3Y=", "created": "2022-09-21 02:06:50", "revenue_type": "Recurring(Hourly)", "business_unit_id": 1, "job_seeker_id": "z5G7h3l6a1kMvyt8FtADVYiT92zvuQREU=", "is_confirmation": 0, "payment_details": [ { "bill_rate_mode": "Hourly", "pay_rate_mode": "Hourly", "client_bill_rate": 100.0, "pay_rate": 80.0, "ot_bill_rate": 150.0, "ot_pay_rate": 120.0, "dt_pay_rate": 150.0, "dt_bill_rate": 200.0, "payment_terms": 1490, "employee_type": "C2C", "currency" : "USD", "recent_revision": 1, "effective_from": "2022-10-03", "effective_until": '', "purchase_order": "purchase order download link here" }, { "bill_rate_mode": "Hourly", "pay_rate_mode": "Hourly", "client_bill_rate": 120.0, "pay_rate": 100.0, "ot_bill_rate": 0.0, "ot_pay_rate": 0.0, "dt_pay_rate": 0.0, "dt_bill_rate": 0.0, "payment_terms": 1490, "employee_type": "C2C", "currency" : "USD", "recent_revision" : 0, "effective_from": "2022-01-01", "effective_until": "2022-10-02", "purchase_order": "purchase order download link here" } ], "overheads": [ { "expense_type": "Pay Roll Tax", "expense_mode": "percentage", "created_at": "2022-10-01 21:51:08", "created_by": "z5G7h3l6a1kMvyS6JewAbSl3MsR3Y=", "amount": 4.0, "percentage": 5.0 }, { "expense_type": "Insurance", "expense_mode": "Fixed", "created_at": "2022-09-21 08:47:44", "created_by": "z5G7h3l6a1kMvyS65qiv_JewAbSl3MsR3Y=", "amount": 5.0, "percentage": null }, { "expense_type": "Admin Costs", "expense_mode": "Fixed", "created_at": "2022-09-21 08:28:41", "created_by": "z5G7h3l6a1kMvyS65NP_JewAbSl3MsR3Y=", "amount": 10.0, "percentage": null } ], "client_details": [ { "client_manager": "Shannon,", "client_email_id": "shannon@acme.com", "client_contactno": "+1585-503-0900", "client_name": "Acme Inc", "address": "687 Lee Rd Suite 208A", "country": "United States", "state": "New York", "city": "Rochester\t" } ], "end_client": [ { "end_client_name": "Acme Inc", "end_client_address": "687 Lee Rd Suite 208A", "end_client_country": "United States", "end_client_state": "New York", "end_client_city": "Rochester", "end_client_zip_code": 14606 } ], "supplier_details": [ { "supplier_federal_id": "10-019293", "supplier_name": "Ceipal", "supplier_contact_person": "John Doe", "supplier_mobile_no": "5855422728", "supplier_office_no": "5855422748", "supplier_email": "john.doe@acme.com", "supplier_addr": "687 Lee Rd", "supplier_country": "United States", "supplier_state": "New York", "supplier_city": "Rochester", "supplier_postal_code": "14606" } ], "work_location": [ { "address": "Long Beach, California", "address2": "", "email_id": "", "country": "United States", "state": "California", "city": "Long Beach", "postal_code": "90844", "mobile_number": "5855422728" } ], "placement_details": [ { "estimated_start_date": "2022-10-03", "job_start_date": "2022-10-03", "job_scheduled_end_date": "2022-10-31", "job_end_date": null, "account_manager": "z5G7h3l6akQqiv_JewAbSl3MsR3Y=", "recruiter": "z5G7h3l6a1kMv_JewAbSl3MsR3Y=", "sales_manager": "z5G7h3l6a1kMQqiv_JewAbSl3MsR3Y=", "new_account_manager": "z5G7kQqiv_JewAbSl3MsR3Y=", "primary_recruiter": "z5G7h3l6a1kM2dOmjPe1Lut_ko=" } ], "placement_status": "Active" } ``` -------------------------------- ### cURL Request to Get Applicant Details Source: https://developer.ceipal.com/ceipal-ats-version-one/applicant-details This cURL command demonstrates how to make a GET request to the CEIPAL API to retrieve applicant details. Ensure you replace placeholder values for the bearer token and IDs. ```bash curl --location 'https://api.ceipal.com/v1/getApplicantDetails/?bearer%20token=&id=' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### cURL Request for Bench Details Source: https://developer.ceipal.com/ceipal-ats-version-one/job-postings This cURL command demonstrates how to fetch detailed bench information by providing the Authorization Bearer token and the benchId in the query parameters. ```bash curl --location 'https://api.ceipal.com/v1/getBenchDetails/?benchId=z5G7h3l6a1kMvyS65NP3c' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJ0eXAiU3NDcyNDYwLCJpY.S2JDSPBLMOvaFpz8pIkTAd94J3T-ju7kUA9YSoxunHA' ``` -------------------------------- ### Response for Get Lead Details (200 OK) Source: https://developer.ceipal.com/ceipal-ats-version-one/authentication This is a sample JSON response when the `getLeadsDetail` API call is successful. It includes various attributes of the lead. ```json { "id": "z5G7h3l6a1kMvykA1ys1oDZyGH9qlAUa1E=", "business_unit_id": 1, "name": "Test345 Solutions", "country": "United States", "state": "Kowloon city", "city": "New Jersey", "zipcode": "968574", "website": "https://wwwwww80980970orp.com", "ownership": "z5G7h3l6a1kMNP3c7IR4bb9gZS6U44tnvwbGXk=", "created_by": "z5G7h3l3c3QylsJA2pfy8ey8BJWTc4E=", "created_at": "2025-04-23 04:11:31", "industry_type": "", "lead_status": "Pre-Qualified", "updated_at": "2025-04-23 04:11:31", "updated_by": "z5G7h3l6a1kMv3QylsJA2pfy8ey8BJWTc4E=", "modified_by": "z5G7h3l6a1kMvySsJA2pfy8ey8BJWTc4E=", "contacts": [], "created_on": "2025-04-23 04:11:31", "modified_on": "2025-04-23 04:11:31" } ``` -------------------------------- ### GET /v1/getCountriesList Source: https://developer.ceipal.com/ceipal-ats-version-one/master-data/business-units Retrieves a list of countries. ```APIDOC ## GET /v1/getCountriesList ### Description Retrieves a list of countries with their associated metadata. ### Method GET ### Endpoint /v1/getCountriesList ### Parameters #### Header Parameters - **Content-Type** (string) - **Authorization** (string) #### Query Parameters - **bearer token** (string) - Required - Get the auth token from the authentication endpoint and pass it as the bearer token ### Response #### Success Response (200) - **id** (number) - **name** (string) - **continent** (string) - **currency** (string) - **iso_currency_code** (string) - **phone_prefix** (string) - **iso** (string) #### Response Example [ { "id": 840, "name": "United States", "continent": "NA", "currency": "Dollar", "iso_currency_code": "USD", "phone_prefix": "1", "iso": "US" }, { "id": 356, "name": "India", "continent": "AS", "currency": "Rupee", "iso_currency_code": "INR", "phone_prefix": "91", "iso": "IN" } ] ```