# Integrations

Basically, an integration resource is what represents you inside the API, which is in turn used to allow data access to sites owned by tenants.

Only one integration resource is required to interface with multiple tenants and sites, but you are free to request multiple ones to suit your needs. (Ex: one for each different software or product lines you are providing)

# Endpoint

https://api.gestal.cloud/integrator

# The integration object

Attribute Type Description
cloud_id string Unique identifier for the object.
name string Integration name as it will appear to tenants.
url string An URL to your product website.
description string Description of your integration it will appear to tenants.

# Example Response

{
  "cloud_id": "int_41soix4ZP9os2M1lsPzwlpbvqnqHJgYH",
  "name": "My integration",
  "url": "https://google.com",
  "description": "Integrate Vision Web API with My integration notification service.",
  "created_at": "2001-01-01T01:01:01.000Z"
}
Last Updated: 8/27/2025, 2:40:38 PM