Loxo API

https://loxo.readme.io/reference/
Admin
Loxo API is a recruitment and staffing platform API that enables management of companies,...
Tokens:96,402
Snippets:483
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### cURL Request Example

Source: https://loxo.readme.io/reference/peopleindex

Demonstrates how to make a GET request to the people endpoint using cURL. Includes the URL and necessary headers.

```shell
curl --request GET \
     --url 'https://app.loxo.co/api/agency_slug/people?fields=' \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/jobsindex

Example of how to make a GET request to the jobs endpoint using cURL. Includes common parameters like postal_code and fields.

```shell
curl --request GET \
     --url 'https://app.loxo.co/api/agency_slug/jobs?postal_code=&fields=' \
     --header 'accept: application/json'
```

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

### cURL Request to Get Cities

Source: https://loxo.readme.io/reference/agency_slugcountriescountry_idstatesstate_idcities

Demonstrates how to make a GET request to retrieve cities using cURL. Ensure to replace placeholders with actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/countries/country_id/states/state_id/cities \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/agency_slugpeopleidenrich

Example of how to make a POST request to the enrich endpoint using cURL. Ensure to replace placeholders like agency_slug and id with actual values.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/people/id/enrich \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get Deal

Source: https://loxo.readme.io/reference/agency_slugdealsid

Use this cURL command to make a GET request to retrieve a specific deal. Ensure you replace `agency_slug` and `id` with actual values.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/deals/id \
     --header 'accept: application/json'
```

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

### cURL Request to Get Job

Source: https://loxo.readme.io/reference/jobsshow

Use this cURL command to make a GET request to retrieve job details. Ensure you replace placeholders with actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/jobs/id \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/agency_slugpeopleperson_idresumes

This example demonstrates how to make a POST request to the resumes endpoint using cURL. Ensure you replace placeholders like {domain}, agency_slug, and person_id with your actual values. The request includes headers for accepting JSON and specifying multipart/form-data content type.

```Shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/people/person_id/resumes \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### GET Request for Company Emails (cURL)

Source: https://loxo.readme.io/reference/company_emailsindex

Use this cURL command to make a GET request to retrieve company emails. Ensure you replace placeholders with actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/companies/company_id/emails \
     --header 'accept: application/json'
```

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

### cURL Request to Get Deals

Source: https://loxo.readme.io/reference/agency_slugdeals

Use this cURL command to make a GET request to the deals endpoint. Ensure you replace `{domain}` with your actual domain and `agency_slug` with the specific agency identifier. The `accept` header should be set to `application/json`.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/deals \
     --header 'accept: application/json'
```

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

### Get Webhook Request (cURL)

Source: https://loxo.readme.io/reference/webhooksshow

Use this cURL command to make a GET request to retrieve a specific webhook. Replace `{domain}`, `agency_slug`, and `id` with your actual values.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/webhooks/id \
     --header 'accept: application/json'
```

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

### cURL Request to Get Deal Workflow

Source: https://loxo.readme.io/reference/agency_slugdeal_workflowsid

Use this cURL command to make a GET request to retrieve a specific deal workflow. Replace `{domain}`, `agency_slug`, and `id` with your actual values. The `accept` header should be set to `application/json`.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/deal_workflows/id \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/agency_slugforms

This example demonstrates how to make a POST request to the forms API endpoint using cURL. Ensure you replace `{domain}` and `agency_slug` with your specific values. The request includes necessary headers for JSON content and multipart form data.

```Shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/forms \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get Campaigns

Source: https://loxo.readme.io/reference/agency_slugcampaigns

Use this cURL command to make a GET request to the campaigns endpoint. Replace `{domain}` with your Loxo domain and `{agency_slug}` with your agency's slug.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/campaigns \
     --header 'accept: application/json'
```

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

### cURL Request to Get Candidates

Source: https://loxo.readme.io/reference/agency_slugjobsjob_idcandidates

Use this cURL command to make a GET request to retrieve candidates for a specific job. Ensure you replace `{domain}`, `{agency_slug}`, and `{job_id}` with your actual values. The `accept` header should be set to `application/json`.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/jobs/job_id/candidates \
     --header 'accept: application/json'
```

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

### Get Form Request (cURL)

Source: https://loxo.readme.io/reference/formsshow

Use this cURL command to make a GET request to retrieve a specific form. Ensure you replace placeholder values with your actual agency slug and form ID.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/forms/id \
     --header 'accept: application/json'
```

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

### cURL Request to Get Seniority Levels

Source: https://loxo.readme.io/reference/agency_slugseniority_levels

Use this cURL command to make a GET request to retrieve seniority levels for a specific agency. Ensure you replace `{domain}` with your actual domain.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/seniority_levels \
     --header 'accept: application/json'
```

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

### cURL Request to Get Deal Workflows

Source: https://loxo.readme.io/reference/agency_slugdeal_workflows

Use this cURL command to make a GET request to retrieve deal workflows for a given agency slug. Ensure you replace 'agency_slug' with the actual agency identifier.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/deal_workflows \
     --header 'accept: application/json'
```

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

### cURL Request to Get Schedule Items

Source: https://loxo.readme.io/reference/agency_slugschedule_items

Use this cURL command to make a GET request to retrieve schedule items. Ensure you replace `{domain}` and `agency_slug` with your specific values. The `accept` header is set to `application/json`.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/schedule_items \
     --header 'accept: application/json'
```

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

### cURL Request to Get Education Types

Source: https://loxo.readme.io/reference/agency_slugeducation_types

Use this cURL command to make a GET request to the education types endpoint. Replace `{domain}` with your Loxo domain and `agency_slug` with the actual agency slug.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/education_types \
     --header 'accept: application/json'
```

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

### Get Deals

Source: https://loxo.readme.io/reference/dealsindex

Retrieves a list of deals. Supports filtering and pagination.

```APIDOC
## GET /api/{agency_slug}/deals

### Description
Retrieves a list of deals associated with a specific agency. This endpoint supports searching and pagination.

### Method
GET

### Endpoint
https://{domain}/api/{agency_slug}/deals

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Query Parameters
- **scroll_id** (string) - Optional - A cursor used to retrieve the next page of results. Returned in each response.
- **query** (string) - Optional - Search query. Supports Lucene query syntax.
- **owner_emails[]** (array of strings) - Optional - Filters deals by owner email addresses.

### Response
#### Success Response (200)
- **deals** (array) - A list of deal objects.
- **next_scroll_id** (string) - The cursor for the next page of results, if available.

### Request Example
```json
{
  "example": ""
}
```

### Response Example
```json
{
  "deals": [
    {
      "id": "deal_123",
      "name": "Example Deal",
      "owner_email": "user@example.com"
    }
  ],
  "next_scroll_id": "some_cursor_value"
}
```
```

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

### cURL GET Request for Dynamic Fields

Source: https://loxo.readme.io/reference/agency_slugdynamic_fields

Use this cURL command to make a GET request to retrieve dynamic fields for a given agency. Ensure you replace `{domain}` and `agency_slug` with your specific values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/dynamic_fields \
     --header 'accept: application/json'
```

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

### Get Placements

Source: https://loxo.readme.io/reference/placementsindex

Retrieves a list of placements. Supports filtering and pagination.

```APIDOC
## GET /api/{agency_slug}/placements

### Description
Retrieves a list of placements associated with a specific agency.

### Method
GET

### Endpoint
https://app.loxo.co/api/{agency_slug}/placements

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Query Parameters
- **scroll_id** (string) - Optional - A cursor used to retrieve the next page of results. Returned in each response.
- **job_id** (integer) - Optional - ID of the job to filter placements by.
- **query** (string) - Optional - Search query. Supports Lucene query syntax.
- **person_global_status_id** (integer) - Optional - Filter placements by person global status ID.
- **include_related_agencies** (boolean) - Optional - Include results from related agencies. Accepts `true` or `false`.

### Response
#### Success Response (200)
- **data** (array) - A list of placement objects.
- **next_scroll_id** (string) - The cursor for the next page of results, if available.

### Response Example
```json
{
  "data": [
    {
      "id": 123,
      "job_id": 456,
      "person_id": 789,
      "status": "active",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:00:00Z"
    }
  ],
  "next_scroll_id": "some_cursor_string"
}
```
```

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

### cURL GET Request for Source Types

Source: https://loxo.readme.io/reference/source_typesshow

Use this cURL command to make a GET request to retrieve a specific source type by its ID. Ensure you replace `{domain}`, `{agency_slug}`, and `{id}` with your actual values.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/source_types/id \
     --header 'accept: application/json'
```

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

### cURL GET Request for Companies

Source: https://loxo.readme.io/reference/companiesindex

Use this cURL command to make a GET request to the companies endpoint. Ensure you replace `{domain}` and `{agency_slug}` with your specific values. The `fields` parameter can be used to specify which company fields to retrieve.

```shell
curl --request GET \
     --url 'https://app.loxo.co/api/agency_slug/companies?fields=' \
     --header 'accept: application/json'
```

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

### cURL GET Request for Job Profiles

Source: https://loxo.readme.io/reference/person_job_profilesindex

Use this cURL command to make a GET request to retrieve job profiles for a specific person. Ensure you replace placeholders like {domain}, {agency_slug}, and {person_id} with actual values. The 'accept' header should be set to 'application/json'.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/people/person_id/job_profiles \
     --header 'accept: application/json'
```

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

### cURL Request to Get Candidate

Source: https://loxo.readme.io/reference/agency_slugjobsjob_idcandidatesid

Use this cURL command to make a GET request to retrieve a specific candidate's details. Ensure you replace placeholders with actual agency slug, job ID, and candidate ID.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/jobs/job_id/candidates/id \
     --header 'accept: application/json'
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/agency_slugpeopleidmerge

Demonstrates how to make a POST request to merge people using cURL. Ensure to replace placeholders with actual values.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/people/id/merge \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### Get Source Types

Source: https://loxo.readme.io/reference/source_typesindex

Retrieves a list of source types. You can filter the results by providing an `after_id` to get records with higher IDs.

```APIDOC
## GET /api/{agency_slug}/source_types

### Description
Retrieves a list of source types.

### Method
GET

### Endpoint
https://app.loxo.co/api/{agency_slug}/source_types

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Query Parameters
- **after_id** (integer) - Optional - Return all records with a higher ID.

### Response
#### Success Response (200)
- **(No specific fields documented)**

### Request Example
```curl
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/source_types \
     --header 'accept: application/json'
```
```

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

### cURL Request Example

Source: https://loxo.readme.io/reference/person_list_itemscreate

Use this cURL command to create a list item for a person. Ensure you replace placeholders like {domain}, {agency_slug}, and {person_id} with your actual values.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/people/person_id/list_items \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### Create Placement using cURL

Source: https://loxo.readme.io/reference/agency_slugplacements

Use this cURL command to create a new placement. Ensure you replace `{agency_slug}` with your actual agency slug and include all required headers.

```Shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/placements \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get States

Source: https://loxo.readme.io/reference/agency_slugcountriescountry_idstates

Use this cURL command to make a GET request to the states endpoint. Replace placeholders with your actual agency slug and country ID.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/countries/country_id/states \
     --header 'accept: application/json'
```

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

### Create Resume

Source: https://loxo.readme.io/reference/resumescreate

This endpoint allows you to upload and create a resume for a specific person within an agency. You can optionally skip the parsing of the resume document.

```APIDOC
## POST /api/{agency_slug}/people/{person_id}/resumes

### Description
Uploads and creates a resume for a specified person.

### Method
POST

### Endpoint
https://{domain}/api/{agency_slug}/people/{person_id}/resumes

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.
- **person_id** (integer) - Required - The unique identifier for the person.

#### Request Body
- **document** (file) - Required - The resume document to upload.
- **source_type_id** (integer) - Required - The type ID of the resume source.
- **skip_parse** (boolean) - Optional - Whether to skip parsing this resume. Defaults to false.

### Response
#### Success Response (200)
- **Updated over 2 years ago**

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### cURL Request to Get Pronouns

Source: https://loxo.readme.io/reference/agency_slugpronouns

Use this cURL command to make a GET request to the pronouns endpoint. Replace `{domain}` with your Loxo domain and `agency_slug` with the specific agency identifier.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/pronouns \
     --header 'accept: application/json'
```

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

### cURL Request to Get Company Email

Source: https://loxo.readme.io/reference/agency_slugcompaniescompany_idemailsid

Use this cURL command to make a GET request to retrieve a specific company email. Replace placeholders with actual IDs and domain.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/companies/company_id/emails/id \
     --header 'accept: application/json'
```

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

### Create Source Type (cURL)

Source: https://loxo.readme.io/reference/agency_slugsource_types

Use this cURL command to send a POST request to create a new source type. Ensure you replace `{domain}` and `agency_slug` with your specific values. The `content-type` header must be `multipart/form-data`.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/source_types \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL GET Request for Campaign

Source: https://loxo.readme.io/reference/agency_slugcampaignsid

Use this cURL command to make a GET request to retrieve a specific campaign by its ID. Ensure you replace `agency_slug` and `id` with actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/campaigns/id \
     --header 'accept: application/json'
```

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

### Create Deal cURL Request

Source: https://loxo.readme.io/reference/dealscreate

Use this cURL command to create a new deal via the API. Ensure you replace `{domain}` and `agency_slug` with your specific values. The `content-type` is set to `multipart/form-data`.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/deals \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get Social Profiles

Source: https://loxo.readme.io/reference/person_social_profilesindex

Use this cURL command to make a GET request to retrieve social profiles for a person. Replace `{domain}`, `{agency_slug}`, and `{person_id}` with your specific values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/people/person_id/social_profiles \
     --header 'accept: application/json'
```

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

### Download Resume

Source: https://loxo.readme.io/reference/agency_slugpeopleperson_idresumesresume_iddownload

This endpoint allows you to download a specific resume associated with a person in an agency.

```APIDOC
## GET /api/{agency_slug}/people/{person_id}/resumes/{resume_id}/download

### Description
Allows downloading a specific resume for a given person within an agency.

### Method
GET

### Endpoint
https://{domain}/api/{agency_slug}/people/{person_id}/resumes/{resume_id}/download

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.
- **person_id** (integer) - Required - The ID of the person whose resume is to be downloaded.
- **resume_id** (integer) - Required - The ID of the resume to download.

### Response
#### Success Response (200)
This endpoint returns the resume file content upon successful retrieval.
```

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

### Create Placement

Source: https://loxo.readme.io/reference/agency_slugplacements

Creates a new placement for a person in a job. This endpoint requires agency slug, person ID, job ID, and start date. Optional fields include end date, salary, bill rates, pay rates, fees, and associated objects for notifications and splits.

```APIDOC
## POST /api/{agency_slug}/placements

### Description
Creates a new placement for a person in a job.

### Method
POST

### Endpoint
https://{domain}/api/{agency_slug}/placements

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Request Body
- **person_id** (integer) - Required - ID of the person being placed.
- **job_id** (integer) - Required - ID of the job the person is being placed in.
- **start_date** (date) - Required - Start date of the placement.
- **end_date** (date) - Optional - End date of the placement.
- **salary** (float) - Optional - Salary amount for the placement.
- **salary_currency_id** (integer) - Optional - ID of the currency for the salary.
- **bill_rate** (float) - Optional - Bill rate for the placement.
- **overtime_bill_rate** (float) - Optional - Overtime bill rate for the placement.
- **bill_rate_type_id** (integer) - Optional - ID of the bill rate type.
- **bill_rate_currency_id** (integer) - Optional - ID of the currency for the bill rate.
- **pay_rate** (float) - Optional - Pay rate for the placement.
- **overtime_pay_rate** (float) - Optional - Overtime pay rate for the placement.
- **pay_rate_type_id** (integer) - Optional - ID of the pay rate type.
- **pay_rate_currency_id** (integer) - Optional - ID of the currency for the pay rate.
- **fee** (float) - Optional - Fee amount for the placement.
- **fee_type_id** (integer) - Optional - ID of the fee type.
- **fee_currency_id** (integer) - Optional - ID of the currency for the fee.
- **job_type_id** (integer) - Optional - ID of the job type.
- **notes** (string) - Optional - Notes about the placement.
- **hours** (float) - Optional - Hours for the placement.
- **days** (integer) - Optional - Days worked per week for daily rate placements (1-7).
- **splits_attributes[]** (object) - Optional - Details for placement splits.
- **notifications_attributes[]** (object) - Optional - Details for placement notifications.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the placement was created successfully.

### Request Example
```json
{
  "person_id": 123,
  "job_id": 456,
  "start_date": "2023-10-27",
  "end_date": "2023-12-31",
  "salary": 50000.00,
  "salary_currency_id": 1,
  "bill_rate": 25.00,
  "pay_rate": 15.00,
  "fee": 1000.00,
  "job_type_id": 2,
  "notes": "Full-time placement.",
  "hours": 40,
  "days": 5,
  "splits_attributes": [
    {
      "user_id": 789,
      "percentage": 50
    }
  ],
  "notifications_attributes": [
    {
      "recipient_id": 101,
      "type": "email"
    }
  ]
}
```

### Response Example
```json
{
  "success": true
}
```
```

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

### Create Placement

Source: https://loxo.readme.io/reference/placementscreate

Creates a new placement for a person in a job. Requires agency slug and details about the placement.

```APIDOC
## POST /api/{agency_slug}/placements

### Description
Creates a new placement for a person in a job.

### Method
POST

### Endpoint
https://{domain}/api/{agency_slug}/placements

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Request Body
- **person_id** (integer) - Required - ID of the person being placed.
- **job_id** (integer) - Required - ID of the job the person is being placed in.
- **start_date** (date) - Required - Start date of the placement.
- **end_date** (date) - Optional - End date of the placement.
- **salary** (float) - Optional - Salary amount for the placement.
- **salary_currency_id** (integer) - Optional - ID of the currency for the salary.
- **bill_rate** (float) - Optional - Bill rate for the placement.
- **overtime_bill_rate** (float) - Optional - Overtime bill rate for the placement.
- **bill_rate_type_id** (integer) - Optional - ID of the bill rate type.
- **bill_rate_currency_id** (integer) - Optional - ID of the currency for the bill rate.
- **pay_rate** (float) - Optional - Pay rate for the placement.
- **overtime_pay_rate** (float) - Optional - Overtime pay rate for the placement.
- **pay_rate_type_id** (integer) - Optional - ID of the pay rate type.
- **pay_rate_currency_id** (integer) - Optional - ID of the currency for the pay rate.
- **fee** (float) - Optional - Fee amount for the placement.
- **fee_type_id** (integer) - Optional - ID of the fee type.
- **fee_currency_id** (integer) - Optional - ID of the currency for the fee.
- **job_type_id** (integer) - Optional - ID of the job type.
- **notes** (string) - Optional - Notes about the placement.
- **hours** (float) - Optional - Hours for the placement.
- **days** (integer) - Optional - Days worked per week for daily rate placements (1-7).
- **splits_attributes[]** (object) - Optional - Splits attributes for the placement.
- **notifications_attributes[]** (object) - Optional - Notifications attributes for the placement.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the placement was created successfully.

### Request Example
```json
{
  "person_id": 123,
  "job_id": 456,
  "start_date": "2023-10-27",
  "end_date": "2023-12-31",
  "salary": 50000.00,
  "salary_currency_id": 1,
  "bill_rate": 75.00,
  "bill_rate_type_id": 1,
  "pay_rate": 30.00,
  "pay_rate_type_id": 1,
  "fee": 1000.00,
  "fee_type_id": 1,
  "job_type_id": 1,
  "notes": "Initial placement for John Doe.",
  "hours": 40,
  "days": 5,
  "splits_attributes": [
    {
      "user_id": 789,
      "percentage": 100
    }
  ],
  "notifications_attributes": [
    {
      "user_id": 789,
      "type": "email"
    }
  ]
}
```

### Response Example
```json
{
  "success": true
}
```
```

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

### cURL Request to Get Schedule Item

Source: https://loxo.readme.io/reference/agency_slugschedule_itemsid

Use this cURL command to make a GET request to retrieve a specific schedule item. Replace `{domain}`, `agency_slug`, and `id` with your actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/schedule_items/id \
     --header 'accept: application/json'
```

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

### cURL Request to Get Person Emails

Source: https://loxo.readme.io/reference/person_emailsindex

Use this cURL command to make a GET request to retrieve a person's email addresses. Replace `{domain}`, `agency_slug`, and `person_id` with your specific values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/people/person_id/emails \
     --header 'accept: application/json'
```

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

### cURL Request to Download Resume

Source: https://loxo.readme.io/reference/agency_slugpeopleperson_idresumesresume_iddownload

Use this cURL command to download a specific resume. Replace placeholders with actual agency, person, and resume IDs. The URL expires after 30 days.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/people/person_id/resumes/resume_id/download \
     --header 'accept: application/json'
```

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

### cURL Request to Get Scorecards

Source: https://loxo.readme.io/reference/agency_slugscorecards

Use this cURL command to make a GET request to the scorecards endpoint. Ensure you replace `{agency_slug}` with the actual agency identifier and include your Bearer token for authentication.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/scorecards \
     --header 'accept: application/json'
```

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

### Retrieve Form Templates (cURL)

Source: https://loxo.readme.io/reference/agency_slugform_templates

Use this cURL command to make a GET request to retrieve form templates. Ensure you replace `{domain}` with your actual domain and `{agency_slug}` with your agency's slug.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/form_templates \
     --header 'accept: application/json'
```

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

### cURL GET Request for People by ID

Source: https://loxo.readme.io/reference/agency_slugpeopleid

Use this cURL command to make a GET request to retrieve a specific person's record. Replace `{domain}`, `agency_slug`, and `id` with your actual values.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/people/id \
     --header 'accept: application/json'
```

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

### cURL GET Request for Placements

Source: https://loxo.readme.io/reference/placementsindex

Use this cURL command to retrieve a list of placements for a specific agency. Ensure you replace `{domain}` and `{agency_slug}` with your actual domain and agency identifier. The `accept` header should be set to `application/json`.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/placements \
     --header 'accept: application/json'
```

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

### Create Scorecard Template (cURL)

Source: https://loxo.readme.io/reference/agency_slugscorecardsscorecard_templates

Use this cURL command to create a new scorecard template. Ensure you replace `{domain}` and `agency_slug` with your specific values. The request uses `multipart/form-data` for file uploads.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/scorecards/scorecard_templates \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data' \
     --form default=true
```

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

### cURL Request to Get Form Template

Source: https://loxo.readme.io/reference/agency_slugform_templatesid

Use this cURL command to make a GET request to retrieve a specific form template. Ensure you replace `{domain}`, `agency_slug`, and `id` with your actual values.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/form_templates/id \
     --header 'accept: application/json'
```

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

### cURL Request to Create Webhook

Source: https://loxo.readme.io/reference/webhookscreate

Use this cURL command to send a POST request to create a webhook. Ensure you replace `{domain}` and `{agency_slug}` with your specific values.

```shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/webhooks \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get Equity Types

Source: https://loxo.readme.io/reference/agency_slugequity_types

Use this cURL command to make a GET request to the Loxo API endpoint for retrieving equity types. Replace `{domain}` and `agency_slug` with your specific values.

```shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/equity_types \
     --header 'accept: application/json'
```

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

### Create Person

Source: https://loxo.readme.io/reference/peoplecreate

Use this endpoint to create a new person record. You can include various details such as profile picture, name, description, location, contact information, and more. The endpoint supports file uploads for profile pictures and resumes.

```APIDOC
## POST /api/{agency_slug}/people

### Description
Creates a new person record with the provided details.

### Method
POST

### Endpoint
https://app.loxo.co/api/{agency_slug}/people

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.

#### Request Body
- **person[profile_picture]** (file) - Optional - Profile picture of the person.
- **person[name]** (string) - Optional - The name of the person.
- **person[description]** (string) - Optional - A description of the person.
- **person[location]** (string) - Optional - The person's location.
- **person[address]** (string) - Optional - The person's address.
- **person[city]** (string) - Optional - The person's city.
- **person[state]** (string) - Optional - The person's state.
- **person[zip]** (string) - Optional - The person's zip code.
- **person[country]** (string) - Optional - The person's country.
- **person[person_global_status_id]** (integer) - Optional - Unique identifier for the person's global status.
- **person[source_type_id]** (integer) - Optional - Identifier for the source type.
- **person[blocked]** (boolean) - Optional - Indicates whether the current person is blocked. Accepts `true` or `false`.
- **person[blocked_until]** (string) - Optional - Timestamp after which the current person will no longer be blocked.
- **person[title]** (string) - Optional - The title of their current job.
- **person[company]** (string) - Optional - The name of the company they currently work at.
- **person[email]** (string) - Optional - Their email address.
- **person[emails][]** (object) - Optional - Additional email addresses.
- **person[phone]** (string) - Optional - Their phone number.
- **person[phones][]** (object) - Optional - Additional phone numbers.
- **person[data_sources][]** (object) - Optional - Data sources associated with the person.
- **person[linkedin_url]** (string) - Optional - The URL of their LinkedIn profile.
- **person[website]** (string) - Optional - The URL of their website.
- **person[resume]** (file) - Optional - Their resume file.
- **person[resume_skip_parse]** (boolean) - Optional - Whether to skip parsing the resume file. Accepts `true` or `false`.
- **person[document]** (file) - Optional - Other documents associated with this person.
- **person[all_raw_tags][]** (string) - Optional - Raw tags associated with the person.
- **person[person_type_id]** (integer) - Optional - Identifier for the person type.
- **person[candidates][]** (object) - Optional - Candidate information.
- **person[list_ids][]** (integer) - Optional - Unique identifiers for lists.
- **person[diversity_type_ids][]** (integer) - Optional - Unique identifiers for diversity types.
- **person[compensation]** (float) - Optional - Compensation amount.
- **person[compensation_notes]** (string) - Optional - Notes regarding compensation.
- **person[salary]** (float) - Optional - Salary amount.
- **person[salary_type_id]** (integer) - Optional - Identifier for the salary type.
- **person[compensation_currency_id]** (integer) - Optional - Identifier for the compensation currency.
- **person[bonus]** (integer) - Optional - Bonus amount.
- **person[bonus_type_id]** (integer) - Optional - Identifier for the bonus type.
- **person[bonus_payment_type_id]** (integer) - Optional - Identifier for the bonus payment type.
- **person[equity]** (float) - Optional - Equity amount.
- **person[equity_type_id]** (integer) - Optional - Identifier for the equity type.
- **person[owned_by_id]** (integer) - Optional - Identifier of the owner.
- **person[$dynamic_field_key]** (string) - Optional - A custom field for the agency.
- **person[$hierarchy_dynamic_field_key][]** (string) - Optional - Hierarchical custom fields for the agency.

### Response
#### Success Response (200)
- **Updated over 2 years ago**

### Request Example
```curl
--request POST \
--url https://app.loxo.co/api/agency_slug/people \
--header 'accept: application/json' \
--header 'content-type: multipart/form-data'
```
```

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

### Create Company cURL Request

Source: https://loxo.readme.io/reference/agency_slugcompanies

Use this cURL command to create a new company. Ensure you replace `{domain}` and `agency_slug` with your specific values. The request uses `multipart/form-data` for sending company details.

```Shell
curl --request POST \
     --url https://app.loxo.co/api/agency_slug/companies \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data'
```

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

### cURL Request to Get Compensation Types

Source: https://loxo.readme.io/reference/agency_slugcompensation_types

Use this cURL command to make a GET request to the compensation types endpoint. Replace `{domain}` with your Loxo domain and `agency_slug` with the specific agency identifier.

```Shell
curl --request GET \
     --url https://app.loxo.co/api/agency_slug/compensation_types \
     --header 'accept: application/json'
```

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

### Apply to a Job

Source: https://loxo.readme.io/reference/jobsapply

This endpoint allows users to apply for a specific job posting by providing candidate details and a resume.

```APIDOC
## POST /api/{agency_slug}/jobs/{job_id}/apply

### Description
Allows users to apply for a specific job posting.

### Method
POST

### Endpoint
https://{domain}/api/{agency_slug}/jobs/{job_id}/apply

### Parameters
#### Path Parameters
- **agency_slug** (string) - Required - The unique identifier for the agency.
- **job_id** (integer) - Required - The unique identifier for the job.

#### Request Body
- **email** (string) - Required - Email of applying candidate. Will lookup existing people.
- **name** (string) - Required - Name of applying candidate.
- **phone** (string) - Required - Phone number of applying candidate.
- **linkedin** (string) - Optional - LinkedIn profile URL of applying candidate.
- **resume** (file) - Optional - Resume of applying candidate.
- **work_authorization** (boolean) - Optional - Indicates if the candidate requires work authorization.
- **requires_visa** (boolean) - Optional - Indicates if the candidate requires visa sponsorship.
- **gender_ids[]** (integer) - Optional - Array of gender IDs.
- **ethnicity_ids[]** (integer) - Optional - Array of ethnicity IDs.
- **veteran_status_id** (integer) - Optional - The ID for veteran status.
- **pronoun_id** (integer) - Optional - The ID for the candidate's pronoun.
- **other_pronoun** (string) - Optional - If 'other' pronoun is selected, specify it here.
- **disability_status_id** (integer) - Optional - The ID for disability status.
- **form_template_id** (integer) - Optional - The ID of the form template to use.
- **source_type_id** (integer) - Optional - The ID of the source type.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the application was successful.
```

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

### OpenAPI Definition for Get Agency Person Emails

Source: https://loxo.readme.io/reference/agency_person_emailsindex

This OpenAPI definition outlines the GET request for retrieving email addresses associated with people in an agency. It specifies parameters for filtering, sorting, and pagination.

```json
{
  "openapi": "3.0.1",
  "servers": [
    {
      "url": "https://{domain}/api",
      "variables": {
        "domain": {
          "default": "app.loxo.co",
          "description": "domain assigned by Loxo"
        }
      }
    }
  ],
  "security": [
    {
      "loxo_bearer_token": []
    }
  ],
  "info": {
    "title": "Loxo API",
    "description": "API for the Loxo application",
    "version": "1.3.1"
  },
  "components": {
    "securitySchemes": {
      "loxo_bearer_token": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/{agency_slug}/people/emails": {
      "get": {
        "operationId": "agency_person_emails:index",
        "responses": {
          "200": {
            "description": "success",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "parameters": [
          {
            "name": "agency_slug",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "A cursor used to retrieve the next page of results. Returned in each response.",
            "name": "scroll_id",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Number of results to return in each page",
            "name": "per_page",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "person_ids[]",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            }
          },
          {
            "description": "Timestamp before which the email was created",
            "name": "created_before",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "datetime"
            }
          },
          {
            "description": "Timestamp after which the email was created",
            "name": "created_after",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "datetime"
            }
          },
          {
            "description": "Timestamp before which the email was updated",
            "name": "updated_before",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "datetime"
            }
          },
          {
            "description": "Timestamp after which the email was updated",
            "name": "updated_after",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "datetime"
            }
          },
          {
            "description": "Sort by created_at in ascending or descending order",
            "name": "created_at_sort",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Sort by updated_at in ascending or descending order",
            "name": "updated_at_sort",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 95,
      "1": 216,
      "2": 44,
      "3": 233,
      "4": 144,
      "5": 80,
      "6": 80,
      "7": 0,
      "8": 108,
      "9": 130,
      "10": 99,
      "11": 166
    }
  }
}
```
Tokens:
Raw