Describe

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

Describe Contact

GET https://api.yourdomain.com/v1/describe/contact

This endpoint describes the fields on the Contact object.

200 Object details retrieved successfully

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

Describe Position

GET https://api.yourdomain.com/v1/describe/position

This endpoint describes the fields on the Position object.

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" },
           ]
}

Describe Education

GET https://api.yourdomain.com/v1/describe/education

This endpoint describes the fields on the Education object.

200 Object details retrieved successfully

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