LogoLogo
Support
  • Bizmate CRM Partner API
    • Overview
    • Authentication
    • Base URL
    • Leads
      • POST - Create Lead
      • GET - Retrieve Lead by ID
      • GET - Retrieve List of Leads
      • PATCH - Update Lead
      • POST - Upload Files
    • Deals
      • GET - Retrieve Deal by ID
      • GET - Retrieve List of Deals
    • Response Codes
    • Lead Status
    • Deal Status
  • BIZMATE PORTAL GUIDE
    • Overview
    • Submitting Leads
    • Other Tips & Resources
    • FAQs
  • Support
    • United Kingdom Support
    • New Zealand Support
    • Australia Support
    • Bizmate Partner Portal
Powered by GitBook
LogoLogo

Support

  • UK Support
  • NZ Support
  • AU Support
  • Bizmate Partner Portal

Copyright © Zwab Ventures PTY LTD (ACN 625 682 831), Bizcap NZ Limited (NZBN 9429048276863) and Bizcap AU Pty Ltd (ACN 633 927 090) of PO Box 195, Balaclava VIC 3183

On this page
Export as PDF
  1. Bizmate CRM Partner API
  2. Deals

GET - Retrieve List of Deals

Retrieve multiple deals at the same time based on the page and page size

Retrieve a list of Deals

Method: GET

Endpoint: /DEAL?page=1&pageSize=100

Headers:

Name
Value

Content-Type

application/json

Authorization

Bearer <API TOKEN>

Example Request (JavaScript - Fetch):

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/deal?page=1&pageSize=100", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Example Request (cURL):

curl --location 'https://bizmate.fasttask.net/api/v1/deal?page=1&pageSize=100' \
--header 'Authorization: Bearer <API TOKEN>'

Response

[
{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}, 
{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}
]
{
  "error": "Invalid request"
}
PreviousGET - Retrieve Deal by IDNextResponse Codes

Last updated 1 month ago