Skip to content

zOne Web Services

The zOne Web Services API enables integration with core platform capabilities,including Maintenance Management, Space Management, and Condition Assessment.

It provides secure endpoints for managing assets, user accounts, reference data, audit trails, file groups, and organizational contacts. These APIs support operational workflows, data synchronization, and system integrations.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Demo
https://demozone.zlinkfm.com/RND

Account Management

Operations

User Management

Operations

User Preferences

Operations

Reference Data

Operations

Organizational Contacts

Operations

Get organizational contacts

Request

This endpoint returns organizational contacts associated with the currently authenticated account.

Behavior:

  • Fetches organizational contacts for the current account
  • Supports filtering, paging, or sorting via the request model
  • Returns a list of organizational contact details
Body
keywordstring or null
sortColumnstring or null
sortColumnIdstring or null(uuid)
sortOrderstring or null
fieldValuesArray of objects or null(zLink.Business.zOne.Base.Common.EntityDataFieldValue)
selectedIdsArray of strings or null(uuid)
datafieldIdsArray of strings or null(uuid)
filterstring or null
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/account/current/contacts \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "keyword": "string",
    "sortColumn": "string",
    "sortColumnId": "0f49f070-9ddb-4e23-bac3-3a9c7797ab4e",
    "sortOrder": "string",
    "fieldValues": [
      {
        "dataFieldId": "b6507240-6286-4e43-b3da-bd23ecf1c322",
        "dataFieldValue": "string",
        "dataFieldlabel": "string",
        "dataFieldValueIds": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "fromDate": "string",
        "toDate": "string",
        "dataFieldValueRangeType": "string"
      }
    ],
    "selectedIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "datafieldIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "filter": "string"
  }'

Responses

OK

Body
dataArray of objects or null(zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Add organizational contact

Request

This endpoint creates a new organizational contact associated with the currently authenticated account.

Behavior:

  • Validates and persists the organizational contact details
  • Associates the contact with the current account
  • Returns the newly created contact information
Body
namestring or null
emailstring or null
profilePicFileIdstring or null(uuid)
phone1string or null
phone2string or null
addressstring or null
descriptionstring or null
secondaryNamestring or null
secondaryEmailstring or null
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/account/current/contacts/Add \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "name": "string",
    "email": "string",
    "profilePicFileId": "85d2ad86-66f3-4595-aa47-a0a38c2e3c03",
    "phone1": "string",
    "phone2": "string",
    "address": "string",
    "description": "string",
    "secondaryName": "string",
    "secondaryEmail": "string"
  }'

Responses

OK

Body
dataobject(zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Get organizational contact details

Request

This endpoint returns detailed information for a single organizational contact associated with the current account.

Behavior:

  • Fetches organizational contact details by identifier
  • Validates the contact against the current account
  • Returns full contact information if found
Path
orgContactIdentifierstringrequired
curl -i -X GET \
  'https://demozone.zlinkfm.com/RND/api/v1/account/current/contacts/{orgContactIdentifier}'

Responses

OK

Body
dataobject(zLink.Business.zOne.Base.ResponseModels.OrganizationalContactsResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger(int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
No response example

Audit Trails

Operations

Equipment

Operations

Employees

Operations

Facility

Operations

Furniture

Operations

Portfolio

Operations

File Management

Operations

Filegroups

Operations

Tasks

Operations

Service Requests

Operations

PM Work Orders

Operations