Get contacts

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

{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}

GET /api-v1/contact

Returns a list of contacts based on the specified 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.
id string

Contact ID filter.

Multi-value supported. Example: value1;value2
contactType string

Contact type filter

Values are ORGANIZATION or PERSON.
name string

Contact name filter
isCustomer boolean

Whether the contact is a customer
isVendor boolean

Whether the contact is a vendor/supplier
isStaff boolean

Whether the contact is a staff member
isUser boolean

Whether the contact has a user account
email string

Email address filter
archived boolean

Whether the contact is archived
hasWarnings boolean

Whether the contact has warnings
isEmployee boolean

Whether the contact is an employee
filterStaffContacts boolean

Whether to filter for staff contacts only

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer(int64)
- organizationId integer(int64)
- contactType string
  
  Values are ORGANIZATION or PERSON.
- name string
- warnings string
- isCustomer boolean
- isVendor boolean
- isStaff boolean
- isUser boolean
- email string
- externalId string
- clientOrderValidity integer(int64)
- creatorContactId integer(int64)
- archived boolean
- hasWarnings boolean
- isEmployee boolean
- tenantId integer(int64)
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/contact

curl \
 --request GET 'https://wyzio.app/api-v1/contact'

Response examples (200)

[
  {
    "id": 42,
    "organizationId": 42,
    "contactType": "ORGANIZATION",
    "name": "string",
    "warnings": "string",
    "isCustomer": true,
    "isVendor": true,
    "isStaff": true,
    "isUser": true,
    "email": "string",
    "externalId": "string",
    "clientOrderValidity": 42,
    "creatorContactId": 42,
    "archived": true,
    "hasWarnings": true,
    "isEmployee": true,
    "tenantId": 42
  }
]