v1

latestOpenAPI 3.0.12026-07-247756110.6 KB
Leads

List Leads

Get a list of Leads

post/lead

Request body

trip_uuidsstring[]

Trip UUIDs

is_bookedboolean

Whether lead is booked or not

sort_by'email' | 'recent_requested_at'

Field name to sort by

sort_dir'desc' | 'asc'

Direction of sorting

lead_typestring

Type of the leads

beforestring date

Recent request before date

afterstring date

Recent request after date

pageinteger

Page number

per_page25 | 50 | 100

Leads per page

Response

Get a list of leads

Example response

{
  "data": [
    {
      "id": 1,
      "trip_uuid": "1234567890",
      "email": "johndoe@mailinator.com",
      "name": "John Doe",
      "phone": "+1 123 456 7890",
      "organizer_id": 1,
      "questions": [
        {
          "content": "What is your name?",
          "created_at": "2017-01-01 00:00:00"
        }
      ],
      "recent_requested_at": "2017-01-01 00:00:00",
      "lead_type": "brochure",
      "trip": {
        "title": "Epic Trip"
      }
    }
  ],
  "pagination": {
    "total_count": 1,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}