Get contacts balance with advanced filters

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}
Close
GET /api-v1/contact-balance/report/advanced

Returns a contacts balance report based on advanced filters.

Headers

  • WEAL-TOKEN Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID

    ID of organization, for which the operation must be performed

Query parameters

  • pageNumber integer

    Page Number

    Default value is 1.

  • sortingField string

    Field to sort by

  • direction string

    Sorting direction

    Values are ASC or DESC. Default value is ASC.

  • sizePerPage integer

    Size per page

    Default value is 60.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer(int64)
    • contactId integer(int64)
    • contactName string
    • contactRoleType string
    • currencyCode string
    • balance number
  • 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/advanced 
curl \
 --request GET 'https://wyzio.app/api-v1/contact-balance/report/advanced'
Response examples (200) 
[
  {
    "id": 42,
    "contactId": 42,
    "contactName": "string",
    "contactRoleType": "string",
    "currencyCode": "string",
    "balance": 42.0
  }
]