latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Leads

Retrieve a single Lead

Retrieves a single Lead by its ID.

get/v2/leads/{id}

Path parameters

idstring required

Example:LD-LwqGJnRwvZPaNe5E

The lead ID (prefix LD-).

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

The requested Lead.

idstring

The ID of the lead (prefix LD-).

uuidstring

The UUID of the lead.

serialIdnumber

The serial ID of the lead.

statusstring

The status of the lead.

datestring date-time

The date and time when the lead is scheduled.

endDatestring date-time

The date and time when the lead is scheduled to end.

isAllDayboolean

Whether the lead is all day.

isScheduledboolean

Whether the lead is scheduled.

descriptionstring

The description of the lead.

leadLostboolean

Whether the lead was marked as lost.

statusUpdatedstring date-time

The date and time when the lead status was last updated (based on account timezone).

updatedAtstring date-time

The date and time when the lead was last updated (based on account timezone).

createdAtstring date-time

The date and time when the lead was created (based on account timezone).

Example response

{
  "id": "LD-LwqGJnRwvZPaNe5E",
  "uuid": "GD87TS",
  "serialId": 12345,
  "status": "Submitted",
  "date": "2022-01-01 10:00:00",
  "endDate": "2022-01-01 10:00:00",
  "isAllDay": true,
  "isScheduled": true,
  "jobType": {
    "id": "JT-8718036049ec4c4d",
    "name": "Repair"
  },
  "adGroup": {
    "id": "AG-71b8d7310acbf8cc",
    "name": "Ad Group 1"
  },
  "description": "This is a description of the lead.",
  "leadLost": true,
  "clientInfo": {
    "clientId": "CL-OvmDp2yvv1yqMwRl",
    "serialId": 1023,
    "firstName": "John Doe",
    "lastName": "Doe",
    "companyName": "Sample Company name",
    "email": "client@workiz.com",
    "primaryExt": "619",
    "primaryPhone": "6195555555",
    "secondaryExt": "613",
    "secondaryPhone": "6195555555",
    "addressDetails": {
      "country": "US",
      "state": "Ohio",
      "city": "San Francisco",
      "zipCode": "94102",
      "address": "462 Powell St",
      "unit": "3422",
      "latitude": -76.2768398,
      "longitude": 36.9669587,
      "locationKey": "462 Powell St, San Francisco, Ohio 94102"
    },
    "serviceArea": {
      "id": "SA-71b8d7310acbf8cc",
      "name": "San Francisco"
    }
  },
  "team": [
    {
      "id": "USR-38c1ee5c4efa38a4",
      "name": "John Doe"
    }
  ],
  "tags": [
    {
      "id": "TAG-8cddc18e7b0458fa",
      "name": "Estimate"
    }
  ],
  "customFields": [
    {
      "id": "CF-eYLPK7198xVp6Z8q",
      "fieldName": "Custom Field 1",
      "value": "John Doe"
    }
  ],
  "notes": [
    {
      "id": "JNT-8cddc18e7b0458fa",
      "techName": "John Doe",
      "note": "This is a note",
      "timestamp": "2022-01-01 10:00:00"
    }
  ],
  "statusUpdated": "2022-01-01 12:00:00",
  "updatedAt": "2022-01-01 12:00:00",
  "createdAt": "2022-01-01 10:00:00"
}