Skip to main content
GET
/
v1
/
crm
/
leads
List Leads
curl --request GET \
  --url https://api.example.com/v1/crm/leads \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "totalCount": 123,
    "totalPages": 123,
    "page": 123,
    "perPage": 123
  },
  "data": [
    {
      "clientPath": "<string>",
      "createdAt": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dba": "<string>",
      "firstName": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "<string>",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amexAccountNumber": "<string>",
      "appProcessingEmail": "jsmith@example.com",
      "assignedTo": {
        "createdAt": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "mfaEnabled": true,
        "timezone": "<string>",
        "updatedAt": "<string>",
        "avatar": "<string>",
        "lastLoginAt": "<string>"
      },
      "underwriterId": {
        "createdAt": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "mfaEnabled": true,
        "timezone": "<string>",
        "updatedAt": "<string>",
        "avatar": "<string>",
        "lastLoginAt": "<string>"
      },
      "averageAmexVolume": 123,
      "averageTicket": 123,
      "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessPhoneNumber": "<string>",
      "cardOnFile": true,
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyWebsite": "<string>",
      "customerServiceEmail": "jsmith@example.com",
      "customReturnPolicy": "<string>",
      "dateEstablished": "<string>",
      "dateSigned": "<string>",
      "yearsInBusiness": 4503599627370495,
      "email": "<string>",
      "federalTaxId": "<string>",
      "industryTypeId": 123,
      "internet": 123,
      "keyed": 123,
      "lastName": "<string>",
      "legal": "<string>",
      "mcc": "<string>",
      "merchantTypeId": 123,
      "monthlyAmexVolume": 123,
      "monthlyVolume": 123,
      "moto": 123,
      "numberOfSalesAgents": 123,
      "officeContactEmail": "jsmith@example.com",
      "partnerLiability": true,
      "partnerLiabilityPercent": 123,
      "phoneNumber": "<string>",
      "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "recruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "relationshipManager": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retail": 123,
      "businessType": "<string>",
      "goodsAndServices": "<string>",
      "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "stateOfIncorporation": "<string>",
      "yearsInPaymentIndustry": 123,
      "nextDayFunding": true,
      "reservePercent": 50,
      "underwriter": {
        "createdAt": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "mfaEnabled": true,
        "timezone": "<string>",
        "updatedAt": "<string>",
        "avatar": "<string>",
        "lastLoginAt": "<string>"
      },
      "bank": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientPath": "<string>",
        "passwordExpirationDays": 123,
        "loginFailureAttempts": 123,
        "loginTimeoutMinutes": 123,
        "tokenTimeoutMinutes": 123,
        "otpValidityMinutes": 123,
        "accountCooldownMinutes": 123,
        "previousPasswordLimit": 123,
        "multifactorEnabled": true,
        "createdAt": "<string>",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updatedAt": "<string>",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "parentClientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dba": "<string>",
        "legal": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "federalTaxId": "<string>",
        "hashedFederalTaxId": "<string>",
        "bankIca": "<string>",
        "bankIsDefault": true,
        "encryptionKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateSigned": "<string>",
        "qaInitiatedAt": "<string>",
        "qaCompletedAt": "<string>",
        "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "underwriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "recruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "relationshipManager": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessPhoneNumber": "<string>",
        "officeContactEmail": "jsmith@example.com",
        "appProcessingEmail": "jsmith@example.com",
        "customerServiceEmail": "jsmith@example.com",
        "numberOfSalesAgents": 123,
        "yearsInPaymentIndustry": 123,
        "partnerLiability": true,
        "partnerLiabilityPercent": 123,
        "mcc": "<string>",
        "industryTypeId": 123,
        "merchantTypeId": 123,
        "dateEstablished": "<string>",
        "stateOfIncorporation": "<string>",
        "companyWebsite": "<string>",
        "averageTicket": 123,
        "monthlyVolume": 123,
        "internet": 123,
        "keyed": 123,
        "moto": 123,
        "retail": 123,
        "monthlyAmexVolume": 123,
        "averageAmexVolume": 123,
        "amexAccountNumber": "<string>",
        "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customReturnPolicy": "<string>",
        "nextDayFunding": true,
        "reservePercent": 50,
        "businessType": "<string>",
        "goodsAndServices": "<string>",
        "yearsInBusiness": 4503599627370495
      },
      "processor": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientPath": "<string>",
        "passwordExpirationDays": 123,
        "loginFailureAttempts": 123,
        "loginTimeoutMinutes": 123,
        "tokenTimeoutMinutes": 123,
        "otpValidityMinutes": 123,
        "accountCooldownMinutes": 123,
        "previousPasswordLimit": 123,
        "multifactorEnabled": true,
        "createdAt": "<string>",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updatedAt": "<string>",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "parentClientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dba": "<string>",
        "legal": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "federalTaxId": "<string>",
        "hashedFederalTaxId": "<string>",
        "bankIca": "<string>",
        "bankIsDefault": true,
        "encryptionKeyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateSigned": "<string>",
        "qaInitiatedAt": "<string>",
        "qaCompletedAt": "<string>",
        "assignedTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "underwriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "recruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "relationshipManager": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessPhoneNumber": "<string>",
        "officeContactEmail": "jsmith@example.com",
        "appProcessingEmail": "jsmith@example.com",
        "customerServiceEmail": "jsmith@example.com",
        "numberOfSalesAgents": 123,
        "yearsInPaymentIndustry": 123,
        "partnerLiability": true,
        "partnerLiabilityPercent": 123,
        "mcc": "<string>",
        "industryTypeId": 123,
        "merchantTypeId": 123,
        "dateEstablished": "<string>",
        "stateOfIncorporation": "<string>",
        "companyWebsite": "<string>",
        "averageTicket": 123,
        "monthlyVolume": 123,
        "internet": 123,
        "keyed": 123,
        "moto": 123,
        "retail": 123,
        "monthlyAmexVolume": 123,
        "averageAmexVolume": 123,
        "amexAccountNumber": "<string>",
        "bankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "processorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "riskCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customReturnPolicy": "<string>",
        "nextDayFunding": true,
        "reservePercent": 50,
        "businessType": "<string>",
        "goodsAndServices": "<string>",
        "yearsInBusiness": 4503599627370495
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter token in following format: Bearer

Query Parameters

q
string
size
number
default:20
page
number
default:1
sort
string
default:-createdAt
filter
object
expand
searchable
string[]
before
object
after
object

Response

The paginated list of leads.

meta
object
required
data
object[]
required