Get Lead

GET 
/crm/leads/:leadId

Get lead based on id

Request

Path Parameters

leadId stringrequired

The item id of the lead record

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

lead

object

remoteId string

leadOwner string

leadSource string

leadTitle string

company string

firstName string

lastName string

addresses

object[]

Array [

country string

street1 string

state string

city string

addressType string

]

emailAddresses

object[]

Array [

emailAddressType string

emailAddress string

]

phoneNumbers

object[]

Array [

phoneNumberType string

phoneNumber string

]

id string

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "lead": {
    "remoteId": "1234567890123",
    "leadOwner": "alex",
    "leadSource": "Trade Show",
    "leadTitle": "Marketing Manager",
    "company": "Bright Future Tech",
    "firstName": "Jordan",
    "lastName": "Smith",
    "addresses": [
      {
        "country": "United States",
        "street1": "123 Sunny Lane",
        "state": "CA",
        "city": "San Francisco",
        "addressType": "main"
      }
    ],
    "emailAddresses": [
      {
        "emailAddressType": "main",
        "emailAddress": "jordan.smith@fakemail.com"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberType": "main",
        "phoneNumber": "123-456-7890"
      }
    ],
    "id": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "lead": {
    "remoteId": "1234567890123",
    "leadOwner": "alex",
    "leadSource": "Trade Show",
    "leadTitle": "Marketing Manager",
    "company": "Bright Future Tech",
    "firstName": "Jordan",
    "lastName": "Smith",
    "addresses": [
      {
        "country": "United States",
        "street1": "123 Sunny Lane",
        "state": "CA",
        "city": "San Francisco",
        "addressType": "main"
      }
    ],
    "emailAddresses": [
      {
        "emailAddressType": "main",
        "emailAddress": "jordan.smith@fakemail.com"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberType": "main",
        "phoneNumber": "123-456-7890"
      }
    ],
    "id": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...