> For the complete documentation index, see [llms.txt](https://leadexporter.gitbook.io/custom-integrations/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://leadexporter.gitbook.io/custom-integrations/describe.md).

# Describe

Describe the fields available on an object. We use this to setup mappings of LeadExporter.io fields to backend system fields.

## Describe Contact

<mark style="color:blue;">`GET`</mark> `https://api.yourdomain.com/v1/describe/contact`

This endpoint describes the fields on the Contact object.

{% tabs %}
{% tab title="200 Object details retrieved successfully" %}

```javascript
{
    "success": true,
    "fields": [
               { "name": "firstName", "label": "First Name" },
               { "name": "lastName", "label": "Last Name" },
               { "name": "email", "label": "E-mail" },
           ]
}
```

{% endtab %}
{% endtabs %}

## Describe Position

<mark style="color:blue;">`GET`</mark> `https://api.yourdomain.com/v1/describe/position`

This endpoint describes the fields on the Position object.

{% tabs %}
{% tab title="200 Object details retrieved successfully" %}

```
{
    "success": true,
    "fields": [
               { "name": "startDate", "label": "Start Date" },
               { "name": "endDate", "label": "End Date" },
               { "name": "company", "label": "Company" },
               { "name": "title", "label": "Title" },
               { "name": "description", "label": "Description" },
           ]
}
```

{% endtab %}
{% endtabs %}

## Describe Education

<mark style="color:blue;">`GET`</mark> `https://api.yourdomain.com/v1/describe/education`

This endpoint describes the fields on the Education object.

{% tabs %}
{% tab title="200 Object details retrieved successfully" %}

```javascript
{
    "success": true,
    "fields": [
               { "name": "startDate", "label": "Start Date" },
               { "name": "endDate", "label": "End Date" },
               { "name": "institute", "label": "Institute" },
               { "name": "degree", "label": "Degree" },
           ]
}
```

{% endtab %}
{% endtabs %}
