host

List customer leads

Changed on

Returns both open and converted leads. A lead with a non-null memberId has converted and can be joined to GET /api/v2/host/members/{memberId}.

get/api/v2/host/customer-leads

Request

  • Base URL
    https://api.momence.com
  • Auth
    OAuth 2
    Authorization code/api/v2/auth/authorize
    Password
    Token URL/api/v2/auth/token

Query parameters

pageinteger required

Starts at 0

pageSizeinteger required
Example:10
sortOrder'ASC' | 'DESC'
sortBy'createdAt'

Field to sort by

querystring

Search leads by first name, last name, email or phone number

sourceIdinteger

Only leads from this lead source

stageIdinteger

Only leads in this lead stage

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "id": 1,
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "phoneNumber": "+420777123456",
      "sourceId": 1,
      "stageId": 1,
      "memberId": 1
    }
  ]
}

Changes