API reference

Organization

15 endpoints in this group.

Gets the organization settings

GET/api/v1/organization

Returns the plan, brand, sending policy, working hours, SLA, test mode, retention period and suspension state. Billing identifiers and keys aren't returned. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
getOrganization · get_organization
MCP tool
getOrganizationread-only

Example request

curl -X GET "https://hiboty.com/api/v1/organization" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "slug": "string",
    "plan": "string",
    "brand": {
      "name": "Hiboty",
      "logo_url": "https://example.com/a.png",
      "color": "string"
    },
    "timezone": "Europe/Istanbul",
    "campaign_frequency_hours": 1,
    "quiet_hours_start": 1,
    "quiet_hours_end": 1,
    "campaign_four_eyes": true,
    "business_hours": {
      "days": [
        1
      ],
      "start": "string",
      "end": "string",
      "message": "string"
    },
    "csat": {
      "question": "string",
      "thank_you": "string"
    },
    "sla_target_minutes": 1,
    "sla_escalation": true,
    "test_mode": true,
    "data_retention_days": 1,
    "suspended": true,
    "suspended_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "legal_hold": true,
    "legal_hold_at": "2026-11-06T09:00:00.000Z"
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Updates the organization settings

PATCH/api/v1/organization

Only the fields you send change; if one is invalid, nothing is written. While test_mode is on, outgoing messages aren't sent to channels; a short data_retention_days permanently deletes older conversation data. campaign_four_eyes (four-eyes approval) can't be written through the API: sending approval control stays in the dashboard. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
updateOrganization · update_organization
MCP tool
updateOrganizationexternal effectirreversible

Body fields

NameTypeRequiredDescription
namestringnolen 2–80
brandobjectno
brand.namestring | nullnolen ≤ 60
brand.logo_urlstring | nullnohttps address or the path value of an uploaded imagelen ≤ 1000
brand.colorstring | nullno#RRGGBB
timezonestringnoIANA time zone
campaign_frequency_hoursenumno0 | 12 | 24 | 48 | 72 | 168
quiet_hours_startinteger | nullnoval 0–23
quiet_hours_endinteger | nullnoval 0–23
business_hoursobject | nullnonull: off
business_hours.daysinteger[]yes
business_hours.startstringyesHH:MM
business_hours.endstringyesHH:MM
business_hours.messagestringyes
csatobject | nullnonull: off
csat.questionstringyes
csat.thank_youstringyes
sla_target_minutesenumno5 | 15 | 30 | 60 | 120 | 240 | 480 | 1440
sla_escalationbooleanno
test_modebooleanno
data_retention_daysenumnonull: no expiry90 | 180 | 365 | 730 | null

Example request

curl -X PATCH "https://hiboty.com/api/v1/organization" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example Store","timezone":"Europe/Istanbul","quiet_hours_start":22,"quiet_hours_end":8,"sla_target_minutes":30}'

Example response (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Hiboty",
    "slug": "string",
    "plan": "string",
    "brand": {
      "name": "Hiboty",
      "logo_url": "https://example.com/a.png",
      "color": "string"
    },
    "timezone": "Europe/Istanbul",
    "campaign_frequency_hours": 1,
    "quiet_hours_start": 1,
    "quiet_hours_end": 1,
    "campaign_four_eyes": true,
    "business_hours": {
      "days": [
        1
      ],
      "start": "string",
      "end": "string",
      "message": "string"
    },
    "csat": {
      "question": "string",
      "thank_you": "string"
    },
    "sla_target_minutes": 1,
    "sla_escalation": true,
    "test_mode": true,
    "data_retention_days": 1,
    "suspended": true,
    "suspended_at": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "legal_hold": true,
    "legal_hold_at": "2026-11-06T09:00:00.000Z"
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Gets the content policy

GET/api/v1/organization/content-policy

Returns the saved policy even when it's off. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
getContentPolicy · get_content_policy
MCP tool
getContentPolicyread-only

Example request

curl -X GET "https://hiboty.com/api/v1/organization/content-policy" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "enabled": true,
    "blocked_phrases": [
      "string"
    ],
    "warned_phrases": [
      "string"
    ],
    "allowed_domains": [
      "string"
    ],
    "blocked_domains": [
      "string"
    ],
    "max_links": 1,
    "max_caps_percent": 1
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Replaces the content policy

PUT/api/v1/organization/content-policy

The whole policy changes: a list you leave out is emptied and a limit you leave out is removed. Values are plain strings; regular expressions aren't accepted. When on, campaigns and scheduled posts are checked against these rules. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
updateContentPolicy · update_content_policy
MCP tool
updateContentPolicy

Body fields

NameTypeRequiredDescription
enabledbooleanyes
blocked_phrasesstring[]noUp to 300 phrases
warned_phrasesstring[]noUp to 300 phrases
allowed_domainsstring[]noUp to 200 domains
blocked_domainsstring[]noUp to 200 domains
max_linksinteger | nullnoval 0–20
max_caps_percentinteger | nullnoval 10–100

Example request

curl -X PUT "https://hiboty.com/api/v1/organization/content-policy" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"blocked_phrases":["guaranteed income"],"warned_phrases":["last chance"],"allowed_domains":["ornek.com"],"blocked_domains":[],"max_links":2,"max_caps_percent":60}'

Example response (200)

JSON
{
  "data": {
    "enabled": true,
    "blocked_phrases": [
      "string"
    ],
    "warned_phrases": [
      "string"
    ],
    "allowed_domains": [
      "string"
    ],
    "blocked_domains": [
      "string"
    ],
    "max_links": 1,
    "max_caps_percent": 1
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Gets the AI settings

GET/api/v1/organization/ai

Keys can never be read; only *_key_set is returned. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
getAiSettings · get_ai_settings
MCP tool
getAiSettingsread-only

Example request

curl -X GET "https://hiboty.com/api/v1/organization/ai" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "provider": "string",
    "model": "string",
    "monthly_limit": 1,
    "anthropic_key_set": true,
    "openrouter_key_set": true,
    "openai_key_set": true
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Updates the AI settings

PATCH/api/v1/organization/ai

Only the fields you send change. api_key is write-only, belongs to the selected provider and is verified with the provider before saving: 400 if invalid, 502 if the provider can't be reached. remove_key deletes the selected provider's key. If the provider changes and no model is sent, that provider's default model is selected. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
updateAiSettings · update_ai_settings
MCP tool
updateAiSettingsexternal effect

Body fields

NameTypeRequiredDescription
providerenumnoanthropic | openrouter | openai
modelstringnolen ≤ 200
monthly_limitintegernoval 0–1000000
api_keystringnolen ≤ 500
remove_keybooleanno

Example request

curl -X PATCH "https://hiboty.com/api/v1/organization/ai" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"openrouter","model":"anthropic/claude-sonnet-5.5","monthly_limit":2000}'

Example response (200)

JSON
{
  "data": {
    "provider": "string",
    "model": "string",
    "monthly_limit": 1,
    "anthropic_key_set": true,
    "openrouter_key_set": true,
    "openai_key_set": true
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
  • 502A channel or external service failed (channel_error).

Lists store connections

GET/api/v1/organization/stores

Encrypted keys aren't returned, only credentials_set and webhook_secret_set. Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
listStores · list_stores
MCP tool
listStoresread-only

Paginated

Parameters

NameTypeRequiredDescription
limitqueryintegernoPage size (1–200, default 50); 400 if it isn't an integerval 1–200, default 50
cursorquerystringnonext_cursor from the previous response (opaque)

Example request

curl -X GET "https://hiboty.com/api/v1/organization/stores?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "platform": "woocommerce",
      "store_url": "https://example.com/a.png",
      "notify_statuses": [
        "string"
      ],
      "language": "tr",
      "notify_opted_out": true,
      "wa_template": {
        "name": "Hiboty",
        "language": "tr"
      },
      "credentials_set": true,
      "webhook_secret_set": true,
      "last_error": "string",
      "last_event_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 409The action isn't possible in this state; the code gives the reason.feature_disabled
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Saves a store connection

PUT/api/v1/organization/stores/{platform}

WooCommerce needs key and secret; Shopify needs token. The address must be public https. A real test request goes to the store; if it fails, nothing is saved (400). Keys and settings you leave out are kept, but they must be sent again if the address changes. Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
saveStore · save_store
MCP tool
saveStoreexternal effect

Parameters

NameTypeRequiredDescription
platformpathenumyesPlatformwoocommerce | shopify

Body fields

NameTypeRequiredDescription
store_urlstringyeslen ≤ 500
keystringno
secretstringno
tokenstringno
webhook_secretstringno
notify_statusesstring[]no
languageenumnotr | en
notify_opted_outbooleanno
wa_templateobject | nullno
wa_template.namestringyeslen 1–200
wa_template.languagestringyeslen 1–20

Example request

curl -X PUT "https://hiboty.com/api/v1/organization/stores/woocommerce" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store_url":"https://magazam.ornek.com","key":"ck_ornekanahtar","secret":"cs_ornekgizli","notify_statuses":["completed"],"language":"tr","notify_opted_out":true}'

Example response (200)

JSON
{
  "data": {
    "platform": "woocommerce",
    "store_url": "https://example.com/a.png",
    "notify_statuses": [
      "string"
    ],
    "language": "tr",
    "notify_opted_out": true,
    "wa_template": {
      "name": "Hiboty",
      "language": "tr"
    },
    "credentials_set": true,
    "webhook_secret_set": true,
    "last_error": "string",
    "last_event_at": "2026-11-06T09:00:00.000Z"
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 409The action isn't possible in this state; the code gives the reason.feature_disabled
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Removes a store connection

DELETE/api/v1/organization/stores/{platform}

Order lookup and status notifications stop. Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
deleteStore · delete_store
MCP tool
deleteStoreirreversible

Parameters

NameTypeRequiredDescription
platformpathenumyesPlatformwoocommerce | shopify

Example request

curl -X DELETE "https://hiboty.com/api/v1/organization/stores/woocommerce" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "platform": "woocommerce",
    "deleted": true
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 409The action isn't possible in this state; the code gives the reason.feature_disabled
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Tests a store connection

POST/api/v1/organization/stores/{platform}/test

A real request goes to the store and the result is written to last_error; a failed connection still returns 200 (connected: false). Returns 409 feature_disabled if the feature is off. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
testStore · test_store
MCP tool
testStoreexternal effect

Parameters

NameTypeRequiredDescription
platformpathenumyesPlatformwoocommerce | shopify

Example request

curl -X POST "https://hiboty.com/api/v1/organization/stores/woocommerce/test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "connected": true,
    "error": "string"
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 409The action isn't possible in this state; the code gives the reason.feature_disabled
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Lists CRM connections

GET/api/v1/integrations/crm

HubSpot and Pipedrive connections; the token is never returned, only token_set. Queued and failed sync job counts are included. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
listCrmConnections · list_crm_connections
MCP tool
listCrmConnectionsread-only

Example request

curl -X GET "https://hiboty.com/api/v1/integrations/crm" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "platform": "hubspot",
      "name": "Hiboty",
      "status": "aktif",
      "token_set": true,
      "company_domain": "string",
      "field_mapping": {
        "tag_field": "string",
        "email_field": "string",
        "order_as_deal": true,
        "deal_stage": "string",
        "note_language": "tr"
      },
      "last_sync_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "last_error_message": "string",
      "last_error_at": "2026-11-06T09:00:00.000Z",
      "pending_jobs": 1,
      "failed_jobs": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    }
  ]
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Saves a CRM connection

POST/api/v1/integrations/crm

The token is tested with a read-only request to the CRM; if it fails nothing is saved (400 crm_connection_failed). HubSpot: a private app token. Pipedrive: an API token and company_domain (e.g. mycompany.pipedrive.com). If no token is sent for an existing connection, the saved token is kept. The token is stored encrypted and never returned. Contacts are matched by phone or email and synced one way; handoffs and Mini App orders become notes or deals. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
saveCrmConnection · save_crm_connection
MCP tool
saveCrmConnectionexternal effect

Body fields

NameTypeRequiredDescription
platformenumyeshubspot | pipedrive
tokenstringnoHubSpot private app token or Pipedrive API tokenlen ≤ 500
company_domainstringnoPipedrive only: company subdomainlen ≤ 200
field_mappingobjectno
field_mapping.tag_fieldstring | nullnoCRM field for tags (HubSpot property name, Pipedrive 40-character custom field key)
field_mapping.email_fieldstring | nullnoHiboty custom field key used when there's no verified email
field_mapping.order_as_dealbooleannoOpen Mini App orders as deals (default true)
field_mapping.deal_stagestring | nullnoDeal stage: HubSpot dealstage internal ID, Pipedrive stage_id
field_mapping.note_languageenumnotr | en

Example request

curl -X POST "https://hiboty.com/api/v1/integrations/crm" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"hubspot","token":"pat-eu1-…","field_mapping":{"tag_field":"hiboty_tags","order_as_deal":true}}'

Example response (201)

JSON
{
  "data": {
    "platform": "hubspot",
    "name": "Hiboty",
    "status": "aktif",
    "token_set": true,
    "company_domain": "string",
    "field_mapping": {
      "tag_field": "string",
      "email_field": "string",
      "order_as_deal": true,
      "deal_stage": "string",
      "note_language": "tr"
    },
    "last_sync_at": "2026-11-06T09:00:00.000Z",
    "last_error": "string",
    "last_error_message": "string",
    "last_error_at": "2026-11-06T09:00:00.000Z",
    "pending_jobs": 1,
    "failed_jobs": 1,
    "created_at": "2026-11-06T09:00:00.000Z",
    "updated_at": "2026-11-06T09:00:00.000Z"
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).crm_connection_failed
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Removes a CRM connection

DELETE/api/v1/integrations/crm

Sync stops; records in the CRM aren't deleted. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
deleteCrmConnection · delete_crm_connection
MCP tool
deleteCrmConnectionirreversible

Parameters

NameTypeRequiredDescription
platformqueryenumyesCRM to removehubspot | pipedrive

Example request

curl -X DELETE "https://hiboty.com/api/v1/integrations/crm?platform=hubspot" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": {
    "platform": "hubspot",
    "deleted": true
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Tests a CRM connection

POST/api/v1/integrations/crm/test

A read-only request goes to the CRM with the saved token and the result is written to the connection. A failed connection still returns 200 (connected: false); an invalid token sets status to hata. Needs admin permission. Scope: organization:write.

Scope
organization:write
SDK method
testCrmConnection · test_crm_connection
MCP tool
testCrmConnectionexternal effect

Body fields

NameTypeRequiredDescription
platformenumyeshubspot | pipedrive

Example request

curl -X POST "https://hiboty.com/api/v1/integrations/crm/test" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"pipedrive"}'

Example response (200)

JSON
{
  "data": {
    "connected": true,
    "error": "string",
    "error_message": "string",
    "connection": {
      "platform": "hubspot",
      "name": "Hiboty",
      "status": "aktif",
      "token_set": true,
      "company_domain": "string",
      "field_mapping": {
        "tag_field": "string",
        "email_field": "string",
        "order_as_deal": true,
        "deal_stage": "string",
        "note_language": "tr"
      },
      "last_sync_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "last_error_message": "string",
      "last_error_at": "2026-11-06T09:00:00.000Z",
      "pending_jobs": 1,
      "failed_jobs": 1,
      "created_at": "2026-11-06T09:00:00.000Z",
      "updated_at": "2026-11-06T09:00:00.000Z"
    }
  }
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 404The record doesn't exist or this key can't access it (not_found).
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.

Lists connections

GET/api/v1/connections

Bot channels (Telegram, WhatsApp number), WhatsApp accounts, store, CRM, AI tools, outgoing webhooks, OAuth apps and product feeds in one list: kind, name, status, last event and last error. Problems come first. Tokens, App Secrets, signing secrets and secret headers are never returned; addresses only return their host name. Store, CRM, webhook and OAuth rows are listed to admins only; a member with restricted bot access only sees connections of the bots they can access. Scope: organization:read.

Scope
organization:read
SDK method
listConnections · list_connections
MCP tool
listConnectionsread-only

Paginated

Parameters

NameTypeRequiredDescription
kindqueryenumnoThis kind onlytelegram_bot | whatsapp_number | whatsapp_account | store | crm | ai_tool | webhook | oauth_app | product_feed
statusqueryenumnoThis status onlybagli | uyari | hata | kapali | bagli_degil
limitqueryintegernoPage size (1–200, default 50); 400 if it isn't an integerval 1–200, default 50
cursorquerystringnonext_cursor from the previous response (opaque)

Example request

curl -X GET "https://hiboty.com/api/v1/connections?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "telegram_bot",
      "name": "Hiboty",
      "detail": "string",
      "status": "bagli",
      "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bot_name": "string",
      "last_event_at": "2026-11-06T09:00:00.000Z",
      "last_error": "string",
      "panel_path": "string"
    }
  ],
  "next_cursor": "string"
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.