GET /api-v1/contact

Headers

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID integer

    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
    • organizationId integer
    • 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
    • creatorContactId integer
    • archived boolean
    • hasWarnings boolean
    • isEmployee boolean
    • tenantId 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 
curl \
 --request GET 'https://wyzio.app/api-v1/contact' \
 --header "WEAL-TOKEN: string" \
 --header "TARGET-ORGANIZATION-ID: 42"
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
  }
]