List Leads

GET 
/crm/leads

List leads based on a given criteria

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

leadOwner string

Filter leads by the exact name of the lead owner.

leadOwnerContains string

Filter leads where the lead owner's name contains the specified string.

leadOwnerNotEquals string

leadOwnerNotEquals

leadSource string

Filter leads by their exact source (e.g., inbound, outbound, referral).

leadSourceContains string

Filter leads where the source contains the specified string.

leadSourceNotEquals string

Filter leads where the source is not the specified string.

leadTitle string

Filter leads by their exact title or job role.

leadTitleContains string

Filter leads where the title contains the specified string.

company string

Filter leads by the exact name of the associated company.

companyContains string

Filter leads where the company name contains the specified string.

companyNotEquals string

Filter leads where the company name is not the specified string.

firstName string

Filter contacts by the exact first name.

leadTitleNotEquals string

Filter leads where the title is not the specified string.

firstNameContains string

Filter contacts whose first name contains the specified string.

firstNameNotEquals string

Filter contacts whose first name is not the specified string.

lastName string

Filter contacts by the exact last name.

lastNameContains string

Filter contacts whose last name contains the specified string.

lastNameNotEquals string

Filter contacts whose last name is not the specified string.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

leads

object[]

Array [

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)

{
  "leads": [
    {
      "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

{
  "leads": [
    {
      "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...