Get total results count for contacts balance

GET /api-v1/contact-balance/report/overall

Headers

  • TARGET-ORGANIZATION-ID integer(int32)

    ID of organization, for which the operation must be performed

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

Responses

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • balance number
    • contactId integer
    • contactName string
    • contactRoleType string
    • currencyCode string
    • id integer
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/contact-balance/report/overall 
curl \
 --request GET 'https://wyzio.app/api-v1/contact-balance/report/overall' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string"
Response examples (200) 
{
  "balance": 42.0,
  "contactId": 42,
  "contactName": "string",
  "contactRoleType": "string",
  "currencyCode": "string",
  "id": 42
}