Skip to main content
GET
/
v1
/
crm
/
partners
List Partners
curl --request GET \
  --url https://api.example.com/v1/crm/partners \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "totalCount": 123,
    "totalPages": 123,
    "page": 123,
    "perPage": 123
  },
  "data": [
    {
      "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": {
        "createdAt": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "mfaEnabled": true,
        "timezone": "<string>",
        "updatedAt": "<string>",
        "avatar": "<string>",
        "lastLoginAt": "<string>"
      },
      "businessPhoneNumber": "<string>",
      "officeContactEmail": "jsmith@example.com",
      "appProcessingEmail": "jsmith@example.com",
      "customerServiceEmail": "jsmith@example.com",
      "numberOfSalesAgents": 123,
      "yearsInPaymentIndustry": 123,
      "partnerLiability": true,
      "partnerLiabilityPercent": 123,
      "bankBinId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "nextDayFunding": true,
      "reservePercent": 50,
      "businessType": "<string>",
      "goodsAndServices": "<string>"
    }
  ]
}

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 partners.

meta
object
required
data
object[]
required