---
title: "Lead Data"
slug: "lead-data"
updated: 2023-04-24T16:00:07Z
published: 2023-04-24T16:00:07Z
canonical: "support.autumna.co.uk/lead-data"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.autumna.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Lead Data

Perform a GET request to:

```markup
https://www.autumna.co.uk/api/leads/
```

With the following fields in a JSON encoded string:

| **Key** | **Required** | **Data Type** | **Description** |
| --- | --- | --- | --- |
| api_key | Yes | 40 character string | Service API Key |
| dateFrom | No | string | yyyy-mm-dd* |
| dateTo | No | string | yyyy-mm-dd* |
| dateTimeFrom | No | string | yyyy-mm-ddThh:mm:ss* |
| dateTimeTo | No | string | yyyy-mm-ddThh:mm:ss* |
| isAnonymised | No | string | **true/false** exclude all anonymised records **Default:** false |
| categoryId | No | Numeric | 1: Contact Form Message 2: In Person Visit Request 3: Virtual Visit Request 4: Call Back Request 5: Email Details Request 6: Referral with contact 7: Referral without contact 8: Placement |
| serviceId | No | Numeric | Service unique ID |

*Please note that all time/date requests should be made using [Universal Coordinated Time (UTC)](https://www.timeanddate.com/time/aboututc.html). For example, to request data at 5pm for anything logged in last 30mins (16:30-17:00), the request will need to specify 15:30-16:00 when the UK is in British Summer Time (BST).

**Example API Request URL:**

```markup
https://www.autumna.co.uk/api/leads/?api_key=aaa0A00AaAa00AAAAAaaAAAaAaAaAAAAaAA0aaAa&dateFrom=2021-01-01&dateTo=2021-09-01&categoryId=1&serviceId=100000&isAnonymised=false
```

**API Response:**

Success will provide a status = 200

Failure will provide a status = 500

The response body will contain a JSON object of data.

**Lead Variables:**

| **Key** | **Description** |
| --- | --- |
| budget_type | Hourly Budget Weekly Budget Monthly Budget Purchase Price |
| funding | Buy Rent Either Buy or Rent Part Buy, Part Rent Self Funding Local Authority with Top-up NHS Continuing Healthcare Not Sure |
| timescales | Emergency ASAP 2-4 weeks 1-3 months 3-6 months 6-12 months Over 12 months Not Sure |
| currentCircumstances | At Home No Care At Home With Care Hospital Discharge Care Home |

###