SAsaleshandy
prospects

Fetch all user prospects with pagination

get/v1/prospects

Request

Query parameters

searchstring

Search by First name, Last name and Email

pageSize10 | 20 | 50 | 100 required

Number of items per page. Values greater than 100 will be capped to 100. Default is 100 if not provided.

pagenumber

Page number for pagination.

sort'ASC' | 'DESC' required

Sort order for the results.

sortBy'createdAt' | 'owner' required

Field to sort the results by. If not selected, default sorting is done by createdAt.

includeCustomFieldsstring

Whether to include custom fields in the response. Use "true" or "false".

Response

Retrieved all prospects successfully

unknown required

Example response

{
  "payload": [
    {
      "id": "jzRkmgMdwA",
      "createdAt": "2022-01-13T09:48:35.824Z",
      "email": "testing.sapna+Tarun@gmail.com",
      "verificationStatus": "valid",
      "attributes": [
        {
          "id": "lPYGOLkyzV",
          "key": "First Name",
          "value": "John"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Last Name",
          "value": "Doe"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Email",
          "value": "john@saleshandy.com"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Company",
          "value": "Company"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Phone Number",
          "value": ""
        },
        {
          "id": "lPYGOLkyzV",
          "key": "City",
          "value": "City"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Country",
          "value": "Country"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "LinkedIn",
          "value": ""
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Job Title",
          "value": ""
        },
        {
          "id": "lPYGOLkyzV",
          "key": "State",
          "value": "state"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Industry",
          "value": "Information Technology"
        },
        {
          "id": "lPYGOLkyzV",
          "key": "Company Domain",
          "value": "example.com"
        }
      ],
      "tags": [
        {
          "id": "bZwpeqMPQL",
          "name": "tag 1",
          "userId": "9KwOp8YP6k"
        },
        {
          "id": "M2zJX4lP3W",
          "name": "tag 2",
          "userId": "9KwOp8YP6k"
        },
        {
          "id": "4bwbkJbPEA",
          "name": "tag 3",
          "userId": "9KwOp8YP6k"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.