### Work History Examples

Source: https://cdn.diligenceai.dev/assets/llms.txt

Examples for retrieving and editing work history records for a candidate.

```json
"WorkHistoryExample": {
                "value": [
                    {
                        "candidate_slug": "1234567750000",
                        "title": "Software Developer",
                        "work_company_name": "Recruit CRM",
                        "employment_type": 2,
                        "industry_id": 3,
                        "work_location": "New York",
                        "salary": 150090,
                        "is_currently_working": 0,
                        "work_start_date": 1603684640,
                        "work_end_date": 1603684678,
                        "work_description": "Supervised a team of 9 employees in all technical and creative aspects of digital advertising campaigns with budgets over $300,000."
                    }
                ]
            }
```

```json
"WorkHistoryEditExample": {
                "value": {
                    "title": "Software Developer",
                    "work_company_name": "Recruit CRM",
                    "employment_type": 2,
                    "industry_id": 3,
                    "work_location": "New York",
                    "salary": 150090,
                    "is_currently_working": 0,
                    "work_start_date": 1603684640,
                    "work_end_date": 1603684678,
                    "work_description": "Supervised a team of 9 employees in all technical and creative aspects of digital advertising campaigns with budgets over $300,000."
                }
            }
```

--------------------------------

### Update Pitch Stage Success Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON response returned when the pitch stage is updated successfully.

```json
{
    "success": true,
    "successCode": 0,
    "message": "string",
    "data": {
        "candidate_slug": "12345",
        "contact_slug": "34234",
        "status_id": 1,
        "stage_date": "2020-03-25T16:14:28.000000Z",
        "remark": "updated remark",
        "created_on": "2020-03-25T16:14:28.000000Z",
        "created_by": 123,
        "updated_on": "2020-03-25T16:14:28.000000Z",
        "updated_by": 123
    }
}
```

--------------------------------

### Job Schema Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON object representing a job posting with required and optional fields.

```json
{
  "name": "Customer Success Manager",
  "number_of_openings": 5,
  "company_slug": 33243,
  "contact_slug": 3445,
  "secondary_contact_slugs": 3445,
  "job_description_text": "Description Text",
  "job_description_file": "file",
  "minimum_experience": 5,
  "maximum_experience": 20,
  "salary_type": 1,
  "currency_id": 2,
  "min_annual_salary": 500000,
  "max_annual_salary": 800000,
  "qualification_id": 4,
  "specialization": "",
  "city": "New York",
  "locality": "Manhattan",
  "state": "",
  "country": "US",
  "address": "",
  "show_company_logo": 1,
  "job_questions": "",
  "collaborator_user_ids": "",
  "collaborator_team_ids": "",
  "note_for_candidates": "Please bring all original documents",
  "custom_fields": [
    {
      "field_id": 1,
      "value": "U"
    }
  ],
  "enable_job_application_form": 1,
  "hiring_pipeline_id": 1,
  "job_location_type": "1",
  "postal_code": "110001"
}
```

--------------------------------

### Pitch History Success Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON response structure for a successful pitch history retrieval.

```json
{
  "data": {
    "records": [
      {
        "status_id": 10,
        "candidate_status": "Pitched",
        "remark": "Pitch History",
        "stage_date": "2023-12-28T17:56:37.000000Z",
        "updated_by": "5",
        "created_on": "2023-12-28T17:56:37.000000Z",
        "updated_on": "2023-12-28T17:56:37.000000Z"
      }
    ]
  },
  "message": "string",
  "status": "string",
  "status code": 0
}
```

--------------------------------

### Pitch Stage Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON response structure for the pitch stage retrieval endpoint.

```json
{
  "status": "string",
  "statusCode": 0,
  "data": {
    "records": [
      {
        "candidate_slug": "16448144215000000005eFC",
        "contact_slug": "16739479639090000005Vsm",
        "stage_date": "2023-12-15T15:26:45.000000Z",
        "status_id": 1,
        "candidate_status": "Pitched",
        "remark": "Remark addded",
        "contact_title": "string",
        "contact_profile_pic": "string",
        "contact_name": "Nicole",
        "contact_email": "nicole@gmail.com",
        "contact_number": "7891781919",
        "candidate_profile_pic": "string",
        "candidate_name": "Wyn Mattheis",
        "candidate_email": "wyn@testmail.com",
        "candidate_contact_number": 62819910101,
        "resume": "string",
        "candidate_position": "Development team lead",
        "created_by": "5"
```

--------------------------------

### GET /v1/hiring-pipelines

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of hiring pipelines.

```APIDOC
## GET /v1/hiring-pipelines

### Description
Returns a list of hiring pipelines.

### Method
GET

### Endpoint
/v1/hiring-pipelines

### Response
#### Success Response (200)
- **MultipleHiringPipeline** (object) - Successful Operation
```

--------------------------------

### Company Object Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON payload for a company object including custom fields.

```json
"examples": {
                                "Example": {
                                    "value": {
                                        "company_name": "Acme Inc",
                                        "city": "New York",
                                        "address": "",
                                        "industry_id": 1,
                                        "logo": "",
                                        "website": "https://www.example.com",
                                        "facebook": "https://facebook.com/acme",
                                        "twitter": "",
                                        "linkedin": "",
                                        "custom_fields": [
                                            {
                                                "field_id": 1,
                                                "value": "ACME-929"
                                            }
                                        ]
                                    }
                                }
                            }
```

--------------------------------

### Candidate History API Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON response structure for a successful fetch of candidate pitch history records.

```json
{
    "data": {
        "records": [
            {
                "contact_slug": "16490671235850000005LSk",
                "status_id": 1,
                "candidate_status": "Pitched",
                "remark": "It is marked as pitched",
                "stage_date": "2023-06-29T05:36:22.000000Z",
                "updated_by": 5,
                "created_on": "2023-06-29T05:36:22.000000Z",
                "updated_on": "2023-06-29T05:36:22.000000Z"
            }
        ]
    },
    "message": "string",
    "status": "string",
    "status code": 0
}
```

--------------------------------

### GET /v1/hiring-pipeline

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of stages in the hiring pipeline.

```APIDOC
## GET /v1/hiring-pipeline

### Description
Returns a list of stages in hiring pipeline.

### Method
GET

### Endpoint
/v1/hiring-pipeline

### Response
#### Success Response (200)
- **CandidateStatus** (object) - Successful Operation
```

--------------------------------

### GET /v1/proficiencies

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of proficiencies.

```APIDOC
## GET /v1/proficiencies

### Description
Returns a list of proficiencies.

### Method
GET

### Endpoint
/v1/proficiencies

### Response
#### Success Response (200)
- **proficiency_id** (integer) - Proficiency identifier
- **label** (string) - Proficiency label
```

--------------------------------

### GET /v1/deals-pipeline

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of stages in the deals pipeline.

```APIDOC
## GET /v1/deals-pipeline

### Description
Returns a list of stages in deals pipeline.

### Method
GET

### Endpoint
/v1/deals-pipeline

### Response
#### Success Response (200)
- **DealPipelineStage** (object) - Successful Operation
```

--------------------------------

### Retrieve Contact Pitch History Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Example JSON response structure for a successful contact history retrieval request.

```json
{
    "data": {
        "records": [
            {
                "candidate_slug": "18390671235850000005LSk",
                "status_id": 1,
                "candidate_status": "Pitched",
                "remark": "It is marked as pitched",
                "stage_date": "2023-06-29T05:36:22.000000Z",
                "updated_by": 5,
                "created_on": "2023-06-29T05:36:22.000000Z",
                "updated_on": "2023-06-29T05:36:22.000000Z"
            }
        ]
    },
    "message": "string",
    "status": "string",
    "status code": 0
}
```

--------------------------------

### GET /v1/pitch-pipeline

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of stages in Pitch Candidate pipeline.

```APIDOC
## GET /v1/pitch-pipeline

### Description
Returns a list of stages in Pitch Candidate pipeline.

### Method
GET

### Endpoint
/v1/pitch-pipeline

### Response
#### Success Response (200)
- **PitchStages** (object) - Successful Operation
```

--------------------------------

### GET /v1/sales-pipeline

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of stages in the sales pipeline.

```APIDOC
## GET /v1/sales-pipeline

### Description
Returns a list of stages in sales pipeline.

### Method
GET

### Endpoint
/v1/sales-pipeline

### Response
#### Success Response (200)
- **ContactStage** (object) - Successful Operation
```

--------------------------------

### GET /v1/deals/search

Source: https://cdn.diligenceai.dev/assets/llms.txt

Search for deals within the system.

```APIDOC
## GET /v1/deals/search

### Description
Search for deals.

### Method
GET

### Endpoint
/v1/deals/search
```

--------------------------------

### GET /v1/hiring-pipelines/{id}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of hiring stages for the requested pipeline.

```APIDOC
## GET /v1/hiring-pipelines/{id}

### Description
Returns a list of hiring stages for the requested pipeline.

### Method
GET

### Endpoint
/v1/hiring-pipelines/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of the hiring pipeline whose stages needs to be returned. 0 is for Master Hiring Pipeline

### Response
#### Success Response (200)
- **CandidateStatus** (object) - Successful Operation
```

--------------------------------

### GET /v1/teams

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of teams.

```APIDOC
## GET /v1/teams

### Description
Returns a list of teams.

### Method
GET

### Endpoint
/v1/teams

### Parameters
#### Query Parameters
- **expand** (string) - Optional - Example: users

### Response
#### Success Response (200)
- **TeamWithUsers** (object) - Successful Operation
```

--------------------------------

### GET /v1/industries

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of industries.

```APIDOC
## GET /v1/industries

### Description
Returns a list of industries.

### Method
GET

### Endpoint
/v1/industries

### Response
#### Success Response (200)
- **Industry** (object) - Successful Operation

#### Error Response (401)
- Unauthorized
```

--------------------------------

### GET /v1/qualifications

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of qualifications.

```APIDOC
## GET /v1/qualifications

### Description
Returns a list of qualifications.

### Method
GET

### Endpoint
/v1/qualifications

### Response
#### Success Response (200)
- **Qualification** (array) - A list of qualifications.

#### Error Response (401)
- **Unauthorized** (string) - Unauthorized access.
```

--------------------------------

### Education History Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Represents an education record for a candidate.

```json
"EducationHistoryExample": {
                "value": [
                    {
                        "candidate_slug": "1234567750000",
                        "institute_name": "Scott Academy",
                        "educational_qualification": "Bachelor's Degree",
                        "educational_specialization": "Computer Science",
                        "grade": "A+",
                        "education_location": "NY",
                        "education_start_date": 1283711400,
                        "education_end_date": 1365445800
```

--------------------------------

### GET /v1/target-report/get

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of Target Reports.

```APIDOC
## GET /v1/target-report/get

### Description
Returns a list of Target Reports.

### Method
GET

### Endpoint
/v1/target-report/get

### Parameters
#### Query Parameters
- **sort_by** (string) - Optional - Sort by field (Default: updated_on)
- **sort_order** (string) - Optional - Sort order (Enum: asc, desc; Default: desc)
- **limit** (integer) - Optional - Limit of records per page. (Max:100)

### Response
#### Success Response (200)
- **TargetReportList** (object) - Successful Operation
```

--------------------------------

### GET /v1/currencies

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of available currencies.

```APIDOC
## GET /v1/currencies

### Description
Returns a list of currencies.

### Method
GET

### Endpoint
/v1/currencies

### Response
#### Success Response (200)
- **Currency** (object) - Successful Operation

#### Error Response (401)
- Unauthorized
```

--------------------------------

### GET /v1/jobs-pipeline

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of stages in the jobs pipeline.

```APIDOC
## GET /v1/jobs-pipeline

### Description
Returns a list of stages in jobs pipeline.

### Method
GET

### Endpoint
/v1/jobs-pipeline

### Response
#### Success Response (200)
- **JobStatus** (object) - Successful Operation
```

--------------------------------

### GET /v1/languages

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of languages.

```APIDOC
## GET /v1/languages

### Description
Returns a list of languages.

### Method
GET

### Endpoint
/v1/languages

### Response
#### Success Response (200)
- **Language** (object) - Successful Operation

#### Error Response (401)
- Unauthorized
```

--------------------------------

### GET /v1/candidate-questions

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of candidate questions available in the system.

```APIDOC
## GET /v1/candidate-questions

### Description
Returns a list of candidate questions.

### Method
GET

### Endpoint
/v1/candidate-questions

### Response
#### Success Response (200)
- **CandidateQuestions** (object) - Successful Operation
```

--------------------------------

### GET /v1/salary-types

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of salary types.

```APIDOC
## GET /v1/salary-types

### Description
Returns a list of salary types.

### Method
GET

### Endpoint
/v1/salary-types

### Response
#### Success Response (200)
- **type_id** (integer) - Salary type identifier
- **label** (string) - Salary Label

#### Error Response (401)
- Unauthorized
```

--------------------------------

### GET /v1/candidates

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieve a list of all candidates associated with the account.

```APIDOC
## GET /v1/candidates

### Description
Returns all candidates associated with your account.

### Method
GET

### Endpoint
/v1/candidates

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination
```

--------------------------------

### GET /candidates

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of candidates with support for pagination and sorting.

```APIDOC
## GET /candidates

### Description
Retrieves a list of candidates. Supports pagination and sorting by specific fields.

### Method
GET

### Endpoint
/candidates

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page. (Max:100)
- **sort_by** (string) - Optional - Sort by field (Options: createdon, updatedon)
- **sort_order** (string) - Optional - Sort order (Options: asc, desc)

### Response
#### Success Response (200)
- **CandidatesNewFieldList** (object) - Successful Operation

#### Error Response (401)
- **ErrorUnauthorized** (object) - Unauthorized
```

--------------------------------

### GET /v1/pitch/pitch-candidate-history/{candidate}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves the pitch history for a specific candidate.

```APIDOC
## GET /v1/pitch/pitch-candidate-history/{candidate}

### Description
Get Pitch History of a Candidate

### Method
GET

### Endpoint
/v1/pitch/pitch-candidate-history/{candidate}

### Parameters
#### Path Parameters
- **candidate** (string) - Required - Candidate's Slug
```

--------------------------------

### GET /v1/task-types

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of task types available in the system.

```APIDOC
## GET /v1/task-types

### Description
Returns a list of Task types.

### Method
GET

### Endpoint
/v1/task-types

### Response
#### Success Response (200)
- **TaskType** (object) - Successful Operation
```

--------------------------------

### GET /v1/deals/{deal}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Finds and returns a single deal by its slug.

```APIDOC
## GET /v1/deals/{deal}

### Description
Returns a single deal based on the provided slug.

### Method
GET

### Endpoint
/v1/deals/{deal}

### Parameters
#### Path Parameters
- **deal** (string) - Required - slug of the deal to return

### Response
#### Success Response (200)
- **Deal** (object) - Successful Operation

#### Error Response (404)
- **error** (boolean) - Deal doesn't exist
- **errorCode** (string) - 404
- **errorMessage** (string) - Deal doesn't exist
```

--------------------------------

### GET /v1/call-logs

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all call logs associated with your account.

```APIDOC
## GET /v1/call-logs

### Description
Returns all call logs associated with your account.

### Method
GET

### Endpoint
/v1/call-logs

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page. (Max:100)

### Response
#### Success Response (200)
- **CallLogsList** (object) - Successful Operation

#### Error Response (401)
- **ErrorUnauthorized** (object) - Unauthorized
```

--------------------------------

### GET /v1/enrollments/search

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all enrollments associated with your account that matched the search criteria.

```APIDOC
## GET /v1/enrollments/search

### Description
Returns all enrollments associated with your account that matched the search.

### Method
GET

### Endpoint
/v1/enrollments/search

### Parameters
#### Query Parameters
- **enrollment_id** (integer) - Optional - Enrollment ID
- **sequence_id** (integer) - Optional - Sequence ID
- **prospect_slug** (string) - Optional - Prospect slug
- **prospect_type** (string) - Optional - Prospect type (candidate, contact)
- **enrollment_status** (integer) - Optional - Enrollment status (1, 2, 3, 4, 5, 6)
- **page** (integer) - Optional - Page Number for Pagination
- **sort_by** (string) - Optional - Sort by field (enrolled_on, updated_on)
- **sort_order** (string) - Optional - Sort order (asc, desc)
```

--------------------------------

### GET /v1/note-types

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of note types available in the system.

```APIDOC
## GET /v1/note-types

### Description
Returns a list of note types.

### Method
GET

### Endpoint
/v1/note-types

### Response
#### Success Response (200)
- **NoteType** (object) - Successful Operation
```

--------------------------------

### GET /v1/tasks

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all tasks associated with your account with support for pagination.

```APIDOC
## GET /v1/tasks

### Description
Returns all tasks associated with your account.

### Method
GET

### Endpoint
/v1/tasks

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page. (Max:100)

### Response
#### Success Response (200)
- **TasksList** (object) - Successful Operation

#### Error Response (401)
- **ErrorUnauthorized** (object) - Unauthorized
```

--------------------------------

### GET /v1/nested-custom-fields

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of all field dependencies associated with your account.

```APIDOC
## GET /v1/nested-custom-fields

### Description
Returns a list of all field dependencies associated with your account. The parent field ID should be included in the payload of the Add/Edit endpoints for all entities to validate nested custom fields.

### Method
GET

### Endpoint
/v1/nested-custom-fields

### Parameters
#### Query Parameters
- **entity_type** (string) - Optional - Accepts 'contacts', 'candidates', 'companies', 'jobs', and 'deals'
- **field_id** (string) - Optional - The ID of the field to filter by
```

--------------------------------

### GET /v1/meeting-types

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns a list of meeting types available in the system.

```APIDOC
## GET /v1/meeting-types

### Description
Returns a list of meeting types.

### Method
GET

### Endpoint
/v1/meeting-types

### Response
#### Success Response (200)
- **MeetingType** (object) - Successful Operation
```

--------------------------------

### GET /v1/candidates/{candidate}/history

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns hiring stage history of the candidate.

```APIDOC
## GET /v1/candidates/{candidate}/history

### Description
Returns hiring stage history of the candidate

### Method
GET

### Endpoint
/v1/candidates/{candidate}/history

### Parameters
#### Path Parameters
- **candidate** (string) - Required - slug of the candidate

### Response
#### Success Response (200)
- **CandidateHistory[]** (array) - Successful Operation
```

--------------------------------

### Candidate Creation Request Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

JSON object representing the required fields for creating a new candidate via multipart/form-data.

```json
{
                                        "first_name": "Michael",
                                        "last_name": "Scott",
                                        "email": "mscott@gmail.com",
                                        "contact_number": "+1123226666",
                                        "gender_id": 1,
                                        "qualification_id": 4,
                                        "specialization": "Computer Science",
                                        "work_ex_year": 2,
                                        "candidate_dob": "2000-06-29T05:36:22.000000Z",
                                        "profile_updated_on": "2020-08-29T05:36:22.000000Z",
                                        "current_salary": "150000",
                                        "salary_expectation": "180000",
                                        "willing_to_relocate": 1,
                                        "current_organization": "",
                                        "current_status": "Employed",
                                        "notice_period": 60,
                                        "currency_id": 2,
                                        "facebook": "http://www.facebook.com/michael4",
                                        "twitter": "http://www.twitter.com/michael4",
                                        "linkedin": "http://www.linkedin.com/michael4",
                                        "github": "",
                                        "created_on": "2020-06-29T05:36:22.000000Z",
                                        "updated_on": "2020-06-29T05:36:22.000000Z"
```

--------------------------------

### GET /v1/hotlists/search

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all hotlists associated with your account that matched the search criteria.

```APIDOC
## GET /v1/hotlists/search

### Description
Returns all hotlists associated with your account that matched the search.

### Method
GET

### Endpoint
/v1/hotlists/search

### Parameters
#### Query Parameters
- **related_to_type** (string) - Required - Associated entity's Name i.e. candidate/ company/ contact/ job
- **name** (string) - Optional - Hotlist Name
- **shared** (integer) - Optional - Hotlist Shared status

### Response
#### Success Response (200)
- **HotlistsList** (object) - Successful Operation
```

--------------------------------

### Example XML Feed Configuration

Source: https://cdn.diligenceai.dev/assets/llms.txt

A JSON representation of default and custom XML feed configurations for job boards.

```json
{
    "default_xml_feeds": [
        {
            "id": 1,
            "label": "Free Job Boards"
        }
    ],
    "custom_xml_feeds": [
        {
            "id": 11,
            "label": "Xing 323"
        },
        {
            "id": 27,
            "label": "test"
        }
    ]
}
```

--------------------------------

### GET /v1/jobs

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all jobs associated with your account with support for pagination and sorting.

```APIDOC
## GET /v1/jobs

### Description
Returns all jobs associated with your account.

### Method
GET

### Endpoint
/v1/jobs

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page. (Max:100)
- **sort_by** (string) - Optional - Sort by field (createdon, updatedon). Default: updatedon
- **sort_order** (string) - Optional - Sort order (asc, desc). Default: desc

### Response
#### Success Response (200)
- **JobsList** (object) - Successful Operation
```

--------------------------------

### GET /v1/jobs/compliance-terms

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves candidate GDPR, EEO policy, and SMS terms.

```APIDOC
## GET /v1/jobs/compliance-terms

### Description
Returns candidate GDPR, EEO policy, and SMS terms.

### Method
GET

### Endpoint
/v1/jobs/compliance-terms

### Response
#### Success Response (200)
- **candidate_terms** (string) - Your custom GDPR terms go here.
- **eeo_policy** (string) - Your EEO policy text here.
- **sms_terms** (string) - Your SMS communication terms here.

#### Response Example
{
  "candidate_terms": "Your custom GDPR terms go here.",
  "eeo_policy": "Your EEO policy text here.",
  "sms_terms": "Your SMS communication terms here."
}
```

--------------------------------

### GET /jobs

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieve a list of jobs based on optional query filters.

```APIDOC
## GET /jobs

### Description
Retrieve a list of job postings filtered by various parameters.

### Method
GET

### Endpoint
/jobs

### Parameters
#### Query Parameters
- **job_type** (number) - Optional - 1 - Part Time, 2 - Full Time, 3 - Contract, 4 - Contract to Permanent
- **job_skill** (string) - Optional - Job Skill
- **job_category** (string) - Optional - Job Category
- **created_from** (string) - Optional - Created (from date)
- **created_to** (string) - Optional - Created (to date)
- **updated_from** (string) - Optional - Updated (from date)
- **updated_to** (string) - Optional - Updated (to date)
- **sort_by** (string) - Optional - Sort by field (createdon, updatedon)
- **sort_order** (string) - Optional - Sort order (asc, desc)
- **job_slug** (string) - Optional - Job Slug (If this filter is applied then other filters will be ignored)
- **owner_id** (string) - Optional - Owner Id
- **owner_name** (string) - Optional - Owner Name
- **owner_email** (string) - Optional - Owner Email
```

--------------------------------

### GET /v1/candidates/{candidate}/hiring-stages/{job}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns the hiring stage of a candidate for a particular job.

```APIDOC
## GET /v1/candidates/{candidate}/hiring-stages/{job}

### Description
Returns the hiring stage of a candidate for a particular job.

### Method
GET

### Endpoint
/v1/candidates/{candidate}/hiring-stages/{job}

### Parameters
#### Path Parameters
- **candidate** (string) - Required - slug of the candidate
- **job** (string) - Required - slug of the job

### Response
#### Success Response (200)
- **CandidateAssignedJob** (object) - Successful Operation

#### Error Response (404)
- **error** (boolean) - Indicates an error occurred
- **errorCode** (string) - Error Code
- **errorMessage** (string) - Error Message
```

--------------------------------

### POST /storeCandidateWorkExperience

Source: https://cdn.diligenceai.dev/assets/llms.txt

Adds a work experience record for a candidate. Note that there is a limit of 50 records per call and a maximum of 10 work history entries per candidate.

```APIDOC
## POST /storeCandidateWorkExperience

### Description
Add a Work Experience for Candidate.

### Method
POST

### Request Body
- **WorkHistoryRequest** (object) - Required - Candidate Work Experience Array of Object. Note: This endpoint has request limit of 50 records per call. Also, a candidate can only have 10 Work History.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **statusCode** (string) - Status Code.
- **message** (string) - Success Message.

#### Error Response (404)
- **error** (boolean) - Indicates an error occurred.
- **errorCode** (string) - Error Code.
- **errorMessage** (string) - Error Message (Candidate doesn't exist).

#### Error Response (429)
- **error** (boolean) - Indicates an error occurred.
- **errorCode** (string) - Error Code (Request limit exceeded).
```

--------------------------------

### GET /v1/meetings

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieve a list of all meetings.

```APIDOC
## GET /v1/meetings

### Description
Show all meetings.

### Method
GET

### Endpoint
/v1/meetings
```

--------------------------------

### GET /v1/candidates/{candidate}/hiring-stages

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of hiring stages for a specific candidate identified by their slug.

```APIDOC
## GET /v1/candidates/{candidate}/hiring-stages

### Description
Returns a list of hiring stages of a candidate.

### Method
GET

### Endpoint
/v1/candidates/{candidate}/hiring-stages

### Parameters
#### Path Parameters
- **candidate** (string) - Required - slug of the candidate

### Response
#### Success Response (200)
- **Successful Operation**
```

--------------------------------

### POST /v1/pitch/{candidate}/contact/{contact}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Mark the candidate as Pitched to the contact.

```APIDOC
## POST /v1/pitch/{candidate}/contact/{contact}

### Description
Mark the candidate as Pitched to the contact.

### Method
POST

### Endpoint
/v1/pitch/{candidate}/contact/{contact}

### Parameters
#### Query Parameters
- **created_by** (integer) - Optional - Created By
```

--------------------------------

### POST /v1/tasks

Source: https://cdn.diligenceai.dev/assets/llms.txt

Creates a new task in the system.

```APIDOC
## POST /v1/tasks

### Description
Creates a new Task.

### Method
POST

### Endpoint
/v1/tasks

### Parameters
#### Request Body
- **TaskRequest** (object) - Required - Task Object

### Response
#### Success Response (200)
- **Response** (object) - Successful Operation
```

--------------------------------

### Assign Candidate Response Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

JSON response structure for a successful candidate assignment operation.

```json
{
	"candidate_slug": "1278655",
	"job_slug": "1206683",
	"status": {
		"status_id": 1,
		"label": "Assigned"
	},
	"remark": "Updated",
	"stage_date": "2020-03-25T16:14:28.000000Z",
	"visibility": 1,
	"shared_list_url": "https://recruitcrm.io/assigned_candidates/001",
	"updated_on": "2020-03-25T16:14:28.000000Z",
	"updated_by": 2354356
}
```

--------------------------------

### GET /v1/off-limit-status

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of off-limit statuses.

```APIDOC
## GET /v1/off-limit-status

### Description
Returns a list of Off Limit Status.

### Method
GET

### Endpoint
/v1/off-limit-status

### Response
#### Success Response (200)
- **OffLimitStatus** (array) - A list of off-limit statuses.

#### Error Response (401)
- **Unauthorized** (string) - Unauthorized access.
```

--------------------------------

### POST /v1/pitch/pitch-candidate/{candidate}/{contact}

Source: https://cdn.diligenceai.dev/assets/llms.txt

Pitches a candidate to a specific contact.

```APIDOC
## POST /v1/pitch/pitch-candidate/{candidate}/{contact}

### Description
Pitches a candidate to a specific contact.

### Method
POST

### Endpoint
/v1/pitch/pitch-candidate/{candidate}/{contact}

### Parameters
#### Path Parameters
- **candidate** (string) - Required - Candidate's Slug
- **contact** (string) - Required - Contact's Slug

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful
- **successCode** (number) - Success Code
- **message** (string) - Success Message
- **data** (object) - Pitch details

#### Response Example
{
  "success": true,
  "successCode": 200,
  "message": "Candidate Pitched Successfully",
  "data": {
    "candidate_slug": "9716881141193400000005acO",
    "contact_slug": "16850938893970000005dqm",
    "status_id": 6,
    "stage_date": "2020-03-25T16:14:28.000000Z",
    "remark": "Marked as Pitched",
    "created_on": "2020-03-28T16:14:28.000000Z",
    "created_by": 5,
    "updated_on": "2020-03-28T16:14:28.000000Z",
    "updated_by": 5
  }
}
```

--------------------------------

### GET /v1/subscriptions

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all subscriptions associated with your account.

```APIDOC
## GET /v1/subscriptions

### Description
Returns all subscriptions associated with your account.

### Method
GET

### Endpoint
/v1/subscriptions

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page.
```

--------------------------------

### GET /v1/companies/search

Source: https://cdn.diligenceai.dev/assets/llms.txt

Search for companies within the system.

```APIDOC
## GET /v1/companies/search

### Description
Search for companies.

### Method
GET

### Endpoint
/v1/companies/search
```

--------------------------------

### POST /v1/candidates/{candidate}/apply

Source: https://cdn.diligenceai.dev/assets/llms.txt

Apply a candidate to a specific job using their slug and the job slug.

```APIDOC
## POST /v1/candidates/{candidate}/apply

### Description
Apply a candidate to a job.

### Method
POST

### Endpoint
/v1/candidates/{candidate}/apply

### Parameters
#### Path Parameters
- **candidate** (string) - Required - slug of the candidate

#### Query Parameters
- **job_slug** (string) - Required - slug of the job
- **updated_by** (integer) - Optional - ID of the user

### Response
#### Success Response (200)
- **candidate_slug** (string) - Candidate slug
- **job_slug** (string) - Job slug
- **status** (object) - Status details
- **shared_list_url** (string) - URL of the shared list
- **remark** (string) - Update remark
- **stage_date** (string) - Date of the stage
- **updated_by** (integer) - ID of the user who updated
- **updated_on** (string) - Date of the update
- **visibility** (integer) - Visibility status

#### Response Example
{
  "candidate_slug": "1205129",
  "job_slug": "1206683",
  "status": {
    "status_id": 1,
    "label": "Applied"
  },
  "shared_list_url": "https://ss4web.recruitcrm.io/assigned_candidates/709831705571173",
  "remark": "Updated",
  "stage_date": "2020-03-25T16:14:28.000000Z",
  "updated_by": 1234,
  "updated_on": "2020-03-25T16:14:28.000000Z",
  "visibility": 1
}
```

--------------------------------

### storeJob

Source: https://cdn.diligenceai.dev/assets/llms.txt

Creates a new job entry in the system.

```APIDOC
## POST storeJob

### Description
Creates a new job posting with the provided details.

### Request Body
- **name** (string) - Required - Name of the job
- **job_status** (number) - Optional - `0` - Closed Job, `1` - Open Job, `2` - On-Hold Job, `3` - Cancelled Job, `Custom Id` - Custom Job Status
- **number_of_openings** (number) - Optional - Number of openings
- **company_slug** (number) - Optional - Company identifier
- **contact_slug** (number) - Optional - Contact identifier
- **secondary_contact_slugs** (number) - Optional - Secondary contact identifiers
- **job_description_text** (string) - Required - Text description of the job
- **job_description_file** (string) - Optional - Binary file for job description
- **minimum_experience** (number) - Optional - Minimum years of experience
- **maximum_experience** (number) - Optional - Maximum years of experience
- **salary_type** (number) - Optional - Salary type identifier
- **currency_id** (number) - Optional - Currency identifier
- **min_annual_salary** (number) - Optional - Minimum annual salary
- **max_annual_salary** (number) - Optional - Maximum annual salary
- **qualification_id** (number) - Optional - Qualification identifier
- **specialization** (string) - Optional - Job specialization
- **job_skill** (string) - Required - Required job skills
- **job_type** (number) - Optional - `1` - Part Time, `2` - Full Time, `3` - Contract, `4` - Contract to Permanent
- **pay_rate** (number) - Optional - Pay rate
- **bill_rate** (number) - Optional - Bill rate
- **job_category** (string) - Required - Job category
- **city** (string) - Required - City location
- **locality** (string) - Required - Locality location
- **state** (string) - Optional - State location
```

--------------------------------

### GET /v1/companies

Source: https://cdn.diligenceai.dev/assets/llms.txt

Returns all companies associated with your account.

```APIDOC
## GET /v1/companies

### Description
Returns all companies associated with your account.

### Method
GET

### Endpoint
/v1/companies

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page Number for Pagination
- **limit** (integer) - Optional - Limit of records per page. (Max:100)
- **sort_by** (string) - Optional - Sort by field (Options: createdon, updatedon; Default: updatedon)
```

--------------------------------

### POST /v1/candidates/work-history/create

Source: https://cdn.diligenceai.dev/assets/llms.txt

Creates a new work history record for a candidate.

```APIDOC
## POST /v1/candidates/work-history/create

### Description
Creates a new work history record for a candidate.

### Method
POST

### Endpoint
/v1/candidates/work-history/create
```

--------------------------------

### GET /v1/users

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of all users associated with the account.

```APIDOC
## GET /v1/users

### Description
Returns a list of users.

### Method
GET

### Endpoint
/v1/users

### Parameters
#### Query Parameters
- **expand** (string) - Optional - Example: team

### Response
#### Success Response (200)
- **UserWithTeams** (object) - Successful Operation
```

--------------------------------

### GET /v1/collaborators

Source: https://cdn.diligenceai.dev/assets/llms.txt

Retrieves a list of collaborators associated with the account.

```APIDOC
## GET /v1/collaborators

### Description
Returns a list of collaborators.

### Method
GET

### Endpoint
/v1/collaborators

### Parameters
#### Query Parameters
- **expand** (string) - Optional - Example: team

### Response
#### Success Response (200)
- **UserWithTeams** (object) - Successful Operation
```

--------------------------------

### POST /candidates

Source: https://cdn.diligenceai.dev/assets/llms.txt

Creates a new candidate record.

```APIDOC
## POST /candidates

### Description
Creates a new Candidate. Use Content-Type: multipart/form-data if you want to upload any file.

### Method
POST

### Endpoint
/candidates

### Request Body
- **CandidateRequest** (object) - Required - Candidate Object

### Request Example
{
  "first_name": "Michael",
  "last_name": "Scott",
  "email": "mscott@gmail.com",
  "contact_number": "+1123226666",
  "gender_id": 1,
  "qualification_id": 4,
  "specialization": "Computer Science",
  "work_ex_year": 2,
  "candidate_dob": "2000-06-29T05:36:22.000000Z",
  "profile_updated_on": "2020-08-29T05:36:22.000000Z",
  "current_salary": "150000",
  "salary_expectation": "180000",
  "willing_to_relocate": 1,
  "current_organization": "",
  "current_status": "Employed",
  "notice_period": 60,
  "currency_id": 2,
  "facebook": "http://www.facebook.com/michael4",
  "twitter": "http://www.twitter.com/michael4",
  "linkedin": "http://www.linkedin.com/michael4",
  "github": "",
  "created_on": "2020-06-29T05:36:22.000000Z",
  "updated_on": "2020-06-29T05:36:22.000000Z"
}
```

--------------------------------

### Deal Entity Example

Source: https://cdn.diligenceai.dev/assets/llms.txt

Represents a deal object including financial data, stage tracking, and collaborator splits.

```json
"Deal": {
                "value": {
                    "name": "Close Full Stack Developer (10 Positions)",
                    "deal_stage": 35,
                    "deal_value": 390000,
                    "close_date": "2000-06-29T05:36:22.000000Z",
                    "deal_type": 1,
                    "deal_percentage_value": "40000",
                    "company_slug": "1369",
                    "contact_slugs": "13691,76890",
                    "job_slug": "11321,432123,555643",
                    "candidate_slug": "980098,554632",
                    "deal_split": {
                        "teammates_collaborator": [
                            {
                                "teammate_id": 5,
                                "split_percentage": 43.98
                            },
                            {
                                "teammate_id": 8,
                                "split_percentage": 29.76
                            }
                        ],
                        "teams_collaborator": [
                            {
                                "team_id": 16,
                                "split_percentage": 6.33
                            },
                            {
                                "team_id": 17,
                                "split_percentage": 42.89
                            }
                        ],
                        "split_type": "custom"
                    },
                    "custom_fields": [
                        {
                            "field_id": 3,
                            "value": "ACC-2"
                        }
                    ]
                }
            }
```

--------------------------------

### POST /v1/candidates/{candidate}/enroll

Source: https://cdn.diligenceai.dev/assets/llms.txt

Enroll a candidate in a specific sequence.

```APIDOC
## POST /v1/candidates/{candidate}/enroll

### Description
Enroll a candidate in a Sequence.

### Method
POST

### Endpoint
/v1/candidates/{candidate}/enroll

### Parameters
#### Path Parameters
- **candidate** (string) - Required - Slug of the candidate

#### Query Parameters
- **sequence_id** (integer) - Required - ID of the sequence
- **enrolled_by** (integer) - Optional - ID of the user

### Response
#### Success Response (200)
- **EnrollCandidate** (object) - Successful Operation

#### Error Response (401)
- **ErrorUnauthorized** (object) - Unauthorized

#### Error Response (422)
- Unprocessable Entity
```