> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Loxo
## What's Supported
### Supported actions
This connector supports:
* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is supported only for `email_tracking`, `person_events` and `sms` currently. For all other objects, a full read of the Loxo instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://{{.domain}}/api/{{.agency_slug}}`.
### Supported Objects
The Loxo connector supports writing and reading from the following objects:
* [activity\_types](https://loxo.readme.io/reference/activity_typesindex) (read)
* [address\_types](https://loxo.readme.io/reference/address_typesindex) (read)
* [bonus\_payment\_types](https://loxo.readme.io/reference/bonus_payment_typesindex) (read)
* [bonus\_types](https://loxo.readme.io/reference/bonus_typesindex) (read)
* [companies](https://loxo.readme.io/reference/companiescreate) (read, write)
* [company\_global\_statuses](https://loxo.readme.io/reference/company_global_statusesindex) (read)
* [company\_types](https://loxo.readme.io/reference/company_typesindex) (read)
* [compensation\_types](https://loxo.readme.io/reference/compensation_typesindex) (read)
* [countries](https://loxo.readme.io/reference/countriesindex) (read)
* [currencies](https://loxo.readme.io/reference/currenciesindex) (read)
* [deal\_workflows](https://loxo.readme.io/reference/deal_workflowsindex) (read)
* [deals](https://loxo.readme.io/reference/dealsindex) (read, write)
* [disability\_statuses](https://loxo.readme.io/reference/disability_statusesindex) (read)
* [diversity\_types](https://loxo.readme.io/reference/diversity_typesindex) (read)
* [dynamic\_fields](https://loxo.readme.io/reference/dynamic_fieldsindex) (read)
* [education\_types](https://loxo.readme.io/reference/education_typesindex) (read)
* [email\_tracking](https://loxo.readme.io/reference/email_trackingindex) (read)
* [email\_types](https://loxo.readme.io/reference/email_typesindex) (read)
* [equity\_types](https://loxo.readme.io/reference/equity_typesindex) (read)
* [ethnicities](https://loxo.readme.io/reference/ethnicitiesindex) (read)
* [fee\_types](https://loxo.readme.io/reference/fee_typesindex) (read)
* [form\_templates](https://loxo.readme.io/reference/form_templatesindex) (read)
* [forms](https://loxo.readme.io/reference/formscreate) (read, write)
* [genders](https://loxo.readme.io/reference/gendersindex) (read)
* [job\_categories](https://loxo.readme.io/reference/job_categoriesindex) (read)
* [job\_contact\_types](https://loxo.readme.io/reference/job_contact_typesindex) (read)
* [job\_owner\_types](https://loxo.readme.io/reference/job_owner_typesindex) (read)
* [job\_statuses](https://loxo.readme.io/reference/job_statusesindex) (read)
* [job\_types](https://loxo.readme.io/reference/job_typesindex) (read)
* [jobs](https://loxo.readme.io/reference/jobscreate) (read, write)
* [people](https://loxo.readme.io/reference/peoplecreate) (read, write)
* [person\_events](https://loxo.readme.io/reference/person_eventsindex) (read, write)
* [person\_global\_statuses](https://loxo.readme.io/reference/person_global_statusesindex) (read)
* [person\_lists](https://loxo.readme.io/reference/person_listsindex) (read)
* [person\_share\_field\_types](https://loxo.readme.io/reference/person_share_field_typesindex) (read)
* [person\_types](https://loxo.readme.io/reference/person_typesindex) (read)
* [phone\_types](https://loxo.readme.io/reference/phone_typesindex) (read)
* [placements](https://loxo.readme.io/reference/placementscreate) (read, write)
* [pronouns](https://loxo.readme.io/reference/pronounsindex) (read)
* [question\_types](https://loxo.readme.io/reference/question_typesindex) (read)
* [schedule\_items](https://loxo.readme.io/reference/schedule_itemsindex) (read)
* [scorecards](https://loxo.readme.io/reference/scorecardsindex) (read, write)
* [scorecards/scorecard\_recommendation\_types](https://loxo.readme.io/reference/scorecard_recommendation_typesindex) (read)
* [scorecards/scorecard\_types](https://loxo.readme.io/reference/scorecard_typesindex) (read)
* [scorecards/scorecard\_templates](https://loxo.readme.io/reference/scorecard_templatescreate) (read, write)
* [scorecards/scorecard\_visibility\_types](https://loxo.readme.io/reference/scorecard_visibility_typesindex) (read)
* [seniority\_levels](https://loxo.readme.io/reference/seniority_levelsindex) (read)
* [sms](https://loxo.readme.io/reference/smsindex) (read, write)
* [social\_profile\_types](https://loxo.readme.io/reference/social_profile_typesindex) (read)
* [source\_types](https://loxo.readme.io/reference/source_typescreate) (read, write)
* [users](https://loxo.readme.io/reference/usersindex) (read)
* [veteran\_statuses](https://loxo.readme.io/reference/veteran_statusesindex) (read)
* [workflow\_stages](https://loxo.readme.io/reference/workflow_stagesindex) (read)
* [workflows](https://loxo.readme.io/reference/workflowsindex) (read)
### Example integration
For an example manifest file of an Loxo integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/loxo/amp.yaml).
## Using the connector
This connector uses **API Key authentication**, so you do not need to configure a Provider App before getting started. (Provider Apps are only required for providers using the **OAuth2 Authorization Code grant type**.)
**Note:**
> * To get the **domain**, log in to your Loxo account and check the URL in your browser’s address bar. It usually follows this pattern: `https://[your-domain-here]`.
> * To get the **agency\_slug**, go to **Settings > General** under **Workspace**. In the **Agency Info** section, look at the **Resume Forwarding Address** — the part before the @ symbol is the **agency\_slug** value.
To integrate with Loxo:
* Create a manifest file similar to the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component, which will prompt the customer for an API key.
* Start using the connector!
* If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
* If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
* If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
## Creating an API key for Loxo
1. Log in to your [Loxo account](https://app.loxo.co/login).
2. Navigate to **settings** and click **API Keys** under **Workspace**.
3. Click **Add** Button.
