Welcome to Zync API

Powerful CRM API for managing properties and availability

Start integrating with our CRM API today

Zync API allows you to retrieve detailed information about sites and offices, and access real-time data about availability.

Base Endpoint: https://creapi.zync-crm.com/

Authentication

Secure your API requests

All API requests require an API key for authentication. Include your API key as a form parameter in every request.

Authentication Method
apikeystring
Your unique API key provided by Zync CRM Systems
✓ Required
Authentication Type: Form-based API Key
Parameter Name: apikey
Location: Request body (form data)

Base URL

API endpoint information

Endpoint

https://creapi.zync-crm.com/

All API operations are performed against this single endpoint. The operation type is specified via the operation form parameter.

Get Site Details

Retrieve detailed information about a specific site

POST

Fetches comprehensive information about a site including details, configuration, and availability data.

Request Parameters
operationstring
The operation to perform. Use GetSiteDetails to retrieve site information.
✓ Required
sitenostring
The unique site number identifier (e.g., "ST00251011")
✓ Required
apikeystring
Your API key for authentication
✓ Required
cURL Example
curl --location 'https://creapi.zync-crm.com/' \
  --form 'operation="GetSiteDetails"' \
  --form 'siteno="ST00251011"' \
  --form 'apikey="YOUR_API_KEY"'
Success Response (200)
{
    "success": true,
    "result": {
        "siteno": "ST00251011",
        "name": "Stanhope House",
        "address": "Stanhope Place, London, UK",
        "city": "Greater London",
        "state": "England",
        "postcode": "W2 2HB",
        "country": "United Kingdom",
        "summary": null,
        "type": "Branch",
        "amenities": [
            "Projector / Display screen ",
            " Printing machine ",
            " Fax machine ",
            " Broadband / wifi ",
            " VOIP ",
            " Furnished office ",
            " Centralized air conditioning"
        ],
        "latitude": "51.5135",
        "longitude": "-0.16296",
        "transport_type": null,
        "images": [
            {
                "image_path": "https://prod-meetingroomz.s3.eu-west-2.amazonaws.com/prod-meetingroomz/meetingroomz/assets/users/GB2508486/image-gallery/bad57284cf6427b75f396141d6ae3412.png",
                "title": "bad57284cf6427b75f396141d6ae3412",
                "filename": "bad57284cf6427b75f396141d6ae3412.png"
            }
        ],
        "availabilities": [
            {
                "day": "Friday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Monday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Saturday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Sunday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Thursday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Tuesday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            },
            {
                "day": "Wednesday",
                "from_time": "00:00:00",
                "to_time": "23:59:00"
            }
        ],
        "offices": [
            {
                "size": "1412.00",
                "capacity": "28",
                "price_month": "18925.00000000",
                "currency_symbol": "£"
            }
        ],
        "similar_sites": {
            "success": true,
            "count": 10,
            "data": [
                {
                    "siteno": "ST002342",
                    "name": "One Great Cumberland Place",
                    "address": "The Orchard, Level 8, 1 Great Cumberland Place, London, W1H 7AL",
                    "city": "London",
                    "state": "",
                    "postcode": "W1H 7AL",
                    "country": "United Kingdom",
                    "summary": null,
                    "type": "Regional",
                    "amenities": [
                        "Projector / Display screen",
                        "Printing machine",
                        "Fax machine",
                        "Broadband / wifi",
                        "VOIP",
                        "Furnished office",
                        "Centralized air conditioning"
                    ],
                    "amenities_count": 7,
                    "latitude": "51.5136",
                    "longitude": "-0.159417",
                    "transport_type": null,
                    "min_capacity": null,
                    "max_capacity": null,
                    "min_price_month": null,
                    "first_image_url": null,
                    "currency_symbol": null,
                    "distance_miles": 0.15
                },               
            ]
        }
    }
}
Error Response (400)
{
    "success": false,
    "error": {
        "message": "Invalid API Key",
        "code": "Error"
    }
}

Get Broker Sites

Retrieve list of sites for a specific broker/agent

POST

Fetches a paginated list of all sites associated with a specific broker/agent. Returns comprehensive site information including contact details and room configurations.

Request Parameters
operationstring
The operation to perform. Use GetBrokerSites to retrieve broker's sites.
✓ Required
paramsJSON string
JSON object containing pagination and agent information
✓ Required
apikeystring
Your API key for authentication
✓ Required
Params Object Structure
pageinteger
Page number for pagination (starts from 1)
per_pageinteger
Number of results per page (recommended: 2000 for maximum results)
agentnostring
The unique agent/broker number (e.g., "ZYNC0043")
✓ Required
cURL Example
curl --location 'https://creapi.zync-crm.com/' \
  --form 'operation="GetBrokerSites"' \
  --form 'params="{\"page\":1,\"per_page\":2000,\"agentno\":\"ZYNC0043\"}"' \
  --form 'apikey="YOUR_API_KEY"'
Success Response (200)
{
    "success": true,
    "result": {
        "success": true,
        "count": 1218,
        "data": [
            {
                "siteno": "ST00251254",
                "name": "49 Southwark Bridge Road",
                "address": "49 Southwark Bridge Road, London, UK",
                "city": "London",
                "state": "London",
                "postcode": "SE1 9HQ",
                "country": "United Kingdom",
                "summary": null,
                "type": "Branch",
                "amenities": {
                    "1": "Printing machine",
                    "2": "Fax machine",
                    "3": "Broadband / wifi",
                    "4": "VOIP",
                    "5": "Furnished office",
                    "6": "Coffee machine",
                    "7": "Shower onsite"
                },
                "amenities_count": 7,
                "latitude": "51.5056",
                "longitude": "-0.095172",
                "transport_type": "",
                "min_capacity": "34",
                "max_capacity": "45",
                "min_price_month": "37474.00000000",
                "first_image_url": "https://prod-meetingroomz.s3.eu-west-2.amazonaws.com/prod-meetingroomz/meetingroomz/assets/users/GB25110553/image-gallery/363e640eef45adb7c18bdf3d9dc1773f.png",
                "currency_symbol": "£"
            },
            {
                "siteno": "ST00251035",
                "name": "11 Cursitor Street",
                "address": "11 Cursitor Street, London, UK",
                "city": "London",
                "state": "England",
                "postcode": "EC4A 1LL",
                "country": "United Kingdom",
                "summary": null,
                "type": "Branch",
                "amenities": [
                    "Disability support",
                    "Fax machine",
                    "Broadband / wifi",
                    "Coffee machine",
                    "Furnished office",
                    "Shower onsite",
                    "Printing machine",
                    "VOIP",
                    "Cycle rack"
                ],
                "amenities_count": 9,
                "latitude": "51.5166",
                "longitude": "-0.110955",
                "transport_type": "",
                "min_capacity": "20",
                "max_capacity": "20",
                "min_price_month": "12690.00000000",
                "first_image_url": "https://prod-meetingroomz.s3.eu-west-2.amazonaws.com/prod-meetingroomz/meetingroomz/assets/users/GB2509507/image-gallery/68c87fbfe746b.jpg",
                "currency_symbol": "£"
            },            
        ],
        "pagination": {
            "total_records": 1218,
            "total_pages": 1,
            "current_page": 1,
            "per_page": 2000,
            "offset": 0,
            "has_next_page": false,
            "has_previous_page": false,
            "next_page": null,
            "previous_page": null
        }
    }
}

Create Lead

Create a new lead/inquiry in the CRM system

POST (Alternate URL)

Creates a new lead entry in the CRM system with visitor information, contact details, and viewing preferences. This endpoint is used to register inquiries and potential bookings.

Note: This endpoint uses the alternate CRM URL:
https://gb0002.zync-crm.com

This is our dedicated domain ID

Request Parameters
operationstring
The operation to perform. Use CreateLead to create a new lead.
✓ Required
elementJSON string
JSON object containing lead information
✓ Required
apikeystring
Your API key for authentication
✓ Required
Element Object Structure
sourcestring
Source of the lead (e.g., "website", "phone", "email", "referral")
✓ Required
firstnamestring
First name of the lead contact
✓ Required
lastnamestring
Last name of the lead contact
✓ Required
emailstring
Email address of the contact
✓ Required
dialcodestring
Country dial code (e.g., "91" for India, "1" for USA)
✓ Required
mobilestring
Mobile phone number without the dial code
✓ Required
messagestring
Additional message or inquiry details
viewingdatestring
Preferred viewing date in format DD-MM-YYYY (e.g., "19-02-2024")
cURL Example
curl --location 'https://gb0002.zync-crm.com' \
  --form 'operation="CreateLead"' \
  --form 'apikey="YOUR_API_KEY"' \
  --form 'element="{\"source\":\"website\",\"firstname\":\"Charlie \",\"lastname\":\"Wells\",\"message\":\"Hello Charlie\",\"dialcode\":\"44\",\"mobile\":\"02085797105.\",\"viewingdate\":\"19-02-2024\",\"email\":\"[email protected]\"}"'
Success Response (200)
{
    "success": true,
    "result": {
        "success": true,
        "id": 00001
    }
}
Error Response (400)
{
  "status": "error",
  "message": "Missing required field: email",
  "error_code": "VALIDATION_ERROR"
}

Error Handling

Understanding API error responses

The API returns structured error responses to help you diagnose issues with your requests.

Common Error Codes
AUTH_ERROR
Invalid or missing API key
INVALID_OPERATION
The operation parameter is not recognized
SITE_NOT_FOUND
The specified site number does not exist
MISSING_PARAMETER
One or more required parameters are missing
SERVER_ERROR
An unexpected server error occurred
Error Response Format:
All errors include a status field set to "error" and a descriptive message explaining the issue.

Code Examples

Integration examples in various programming languages

JavaScript / Node.js

const fetch = require('node-fetch');
const FormData = require('form-data');

const form = new FormData();
form.append('operation', 'GetSiteDetails');
form.append('siteno', 'ST00251011');
form.append('apikey', 'YOUR_API_KEY');

fetch('https://creapi.zync-crm.com/', {
  method: 'POST',
  body: form
})
.then(res => res.json())
.then(data => console.log(data))
.catch(err => console.error(err));

Python

import requests

url = 'https://creapi.zync-crm.com/'
data = {
    'operation': 'GetSiteDetails',
    'siteno': 'ST00251011',
    'apikey': 'YOUR_API_KEY'
}

response = requests.post(url, data=data)
result = response.json()
print(result)

PHP

$url = 'https://creapi.zync-crm.com/';
$data = array(
    'operation' => 'GetSiteDetails',
    'siteno' => 'ST00251011',
    'apikey' => 'YOUR_API_KEY'
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$result = json_decode($response, true);
print_r($result);