Перейти к основному содержанию
GET
/
v1
/
crm
/
integrations
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/integrations/
[
  {
    "id": 123,
    "code": "<string>",
    "name": "<string>",
    "prices": [
      {
        "id": 123,
        "variant": {
          "id": 123,
          "name": "<string>",
          "code": "<string>",
          "limits": [
            "<string>"
          ]
        },
        "integration": 123,
        "type": "period",
        "currency": "KZT",
        "days": 30,
        "price": "<string>",
        "amount": -1,
        "tenant": 123
      }
    ],
    "variants": [
      {
        "id": 123,
        "name": "<string>",
        "code": "<string>",
        "limits": [
          "<string>"
        ]
      }
    ],
    "extra": {
      "fields": [
        "<string>"
      ],
      "specs": [
        {
          "name": "<string>",
          "label": "<string>",
          "params": "<unknown>"
        }
      ],
      "is_yume_cloud": false,
      "link": "<string>",
      "manual": true
    },
    "slug": "<string>",
    "comment": "<string>",
    "slogan": "<string>",
    "type": "integration",
    "detail": "<string>",
    "icon": "<string>",
    "image": "<string>",
    "image_alt": "<string>",
    "disabled": true,
    "demo_enabled": true,
    "demo_duration": "<string>",
    "tags": [
      "free"
    ],
    "modules": [
      "finance"
    ],
    "visable": true
  }
]

Параметры запроса

ordering
string

Which field to use when ordering the results.

A search term.

type
enum<string>

Тип интеграции

  • integration - integration
  • module - module
Доступные опции:
integration,
module

Ответ

200 - application/json
id
integer
обязательно
code
string
обязательно

Код интеграции

Maximum string length: 64
name
string
обязательно

Название интеграции

Maximum string length: 512
prices
object[]
обязательно
variants
object[]
обязательно
extra
object
обязательно
slug
string | null
Maximum string length: 255
Pattern: ^[-a-zA-Z0-9_]+$
comment
string | null
Maximum string length: 512
slogan
string | null

Слоган интеграции

type
enum<string>

Тип интеграции

  • integration - integration
  • module - module
Доступные опции:
integration,
module
detail
string | null

Описание интеграции

icon
string<uri> | null

Иконка интеграции

image
string<uri> | null

Изображение интеграции

image_alt
string<uri> | null

Альтернативное изображение интеграции

disabled
boolean

Отключено интеграцию

demo_enabled
boolean

Демо интеграция

demo_duration
string
tags
enum<string>[]
  • free - free
  • promo - promo
  • popular - popular
  • recommend - recommend
Доступные опции:
free,
promo,
popular,
recommend
modules
enum<string>[]

Модули интеграции

  • finance - Финансы
  • sales - Продажи
  • marketing - Маркетинг
  • other - Другое
  • hr - HR
Доступные опции:
finance,
sales,
marketing,
other,
hr
visable
boolean

Видимость интеграции для пользователей