Vendors

📘
Only available to accounting add-on subscribers.

Pull your vendor data through our API, allowing you to reduce your workload and spend less time on large spreadsheets and inefficient processes.

Reference Docs

Available Endpoints

Method	Endpoint
GET	v1/vendors
GET	v1/vendors/{id}

Key Parameters

Parameter	Description
`count`	The total number of vendor records on the account.
`results`	Array of the vendor objects.
-- `_id`	The Guesty vendor ID.
-- `company`	Vendor company name.
-- `firstName`	First name of proprietor or primary contact.
-- `lastName`	Surname of proprietor or primary contact.
-- `phone`	Vendor's phone number.
-- `email`	Vendor's email address.
-- `address`	Vendor's business address.
-- `code`	Tax vendor code. E.g. VAT / GST / Etc.
-- `notes`	General notes section.

📘
What is a tax vendor?
When you configure a tax on Guesty, the system will automatically generate a vendor for it upon the receipt of the first reservation to which the tax is applied. A tax vendor can't be created manually, nor can it be edited. It enables you to properly track taxes owed.

Retrieving All Vendors

This request retrieves a list of all vendors on your Guesty account.

Example Request

curl --location 'https://open-api.guesty.com/v1/vendors?limit=25'

🚧
The limit query parameter cannot be less than 25 when employed.

Response

This response is only an excerpt of the full results. It is still a complete example.

{
    "count": 96,
    "results": [
        {
            "id": "6434051e3ab9db217b1796b2",
            "company": "Stripe",
            "firstName": "Stripe",
            "lastName": "payment",
            "fullName": "Stripe payment",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "63cea6fe0eff7287d9aef373",
            "company": "Siestakey cleaning",
            "firstName": "Siestakey",
            "lastName": "Cleaning",
            "fullName": "Siestakey Cleaning",
            "phone": [
                "+1 31231233312"
            ],
            "email": [
                "[email protected]"
            ],
            "address": "asdasdasdadasda",
            "code": null,
            "notes": "sadasds, asd,asd asd asd asd a"
        },
        {
            "id": "63ce8c480eff7287d9aef372",
            "company": "Huswell-Cleaning",
            "firstName": "Huswell",
            "lastName": "Cleaning",
            "fullName": "Huswell Cleaning",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "637ce861e34ab714a8330837",
            "company": "Cleaning ",
            "firstName": "Chady Property Management",
            "lastName": "Cleaning",
            "fullName": "Chady Property Management Cleaning",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "63724521ee28b3ab4b97d548",
            "company": "ATNT",
            "firstName": "ATNT",
            "lastName": "ATNT",
            "fullName": "ATNT ATNT",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": "eee"
        },
        {
            "id": "635839cc37b6b6005e9b44c8",
            "company": "Costco",
            "firstName": "Costco",
            "lastName": "Company",
            "fullName": "Costco Company",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "633c60278d915e003498dbf2",
            "company": "Amazon",
            "firstName": "Amazon",
            "lastName": "Company",
            "fullName": "Amazon Company",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "62c6b1993542080033c2fa83",
            "company": "Guesty",
            "firstName": "Inessa",
            "lastName": "TEST",
            "fullName": "Inessa TEST",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        },
        {
            "id": "626f983b18a2730035c26f51",
            "company": "Lviv",
            "firstName": "Test_Harry",
            "lastName": "Potter",
            "fullName": "Test_Harry Potter",
            "phone": [],
            "email": [
                "[email protected]"
            ],
            "address": null,
            "code": null,
            "notes": null
        }
    ]
}

Retrieving a Single Vendor

This requests returns the details of a specific vendor.

Example Request

curl --location 'https://open-api.guesty.com/v1/vendors/63cea6fe0eff7287d9aef373'

Response

{
    "id": "63cea6fe0eff7287d9aef373",
    "company": "Siestakey cleaning",
    "firstName": "Siestakey",
    "lastName": "Cleaning",
    "fullName": "Siestakey Cleaning",
    "phone": [
        "+1 31231233312"
    ],
    "email": [
        "[email protected]"
    ],
    "address": "asdasdasdadasda",
    "code": null,
    "notes": "sadasds, asd,asd asd asd asd a"
}

📘

📘What is a tax vendor?

Retrieving All Vendors

🚧

Retrieving a Single Vendor

📘
What is a tax vendor?