Skip to main content

PaginatedResponse[AgentIntegrationRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    agent_idAgent Idrequired

    ID of the agent (a configured AI assistant / bot persona) this record belongs to.

    integration_idIntegration Idrequired

    ID of the company integration this binding connects the agent to.

    config objectrequired

    Calendar configuration for this agent (bookable accounts, services, scheduling).

    enabledEnabled
    Default value: true
    max_lookahead_hoursMax Lookahead Hours
    Default value: 168
    meeting_duration_minutesMeeting Duration Minutes
    Default value: 30
    booking_lead_time_working_daysBooking Lead Time Working Days

    Number of upcoming working days during which all calendar slots are hidden and booking attempts are rejected. The current day counts when it is a configured working day; 0 disables the restriction.

    Possible values: >= 0

    Default value: 0
    daily_booking_limitDaily Booking Limit

    Maximum active meetings the agent may book across all configured calendar accounts on one local calendar day. 0 means unlimited.

    Possible values: >= 0

    Default value: 0
    slot_step_minutesSlot Step Minutes

    Step, in minutes, used when generating possible meeting start times inside a free calendar window. This is separate from meeting_duration_minutes.

    Possible values: > 0

    Default value: 5
    attach_crm_link_to_eventAttach Crm Link To Event
    Default value: true
    titleTitle
    Default value: Meeting with Lead (auto)
    create_description_summaryCreate Description Summary
    Default value: true
    accounts object
    property name* CalendarAccountConfig
    account objectrequired

    A bookable calendar account (e.g. a sales manager's calendar) exposed by a calendar integration.

    idIdrequired

    The account's id at the calendar provider.

    nameNamerequired

    The account's display name.

    enabled_services_idsstring[]

    IDs of the bookable services enabled for this account.

    schedule object

    Maps each weekday to its working-hours configuration.

    days objectrequired

    Map of weekday ("0"=Monday … "6"=Sunday) to that day's working-hours config.

    property name* ScheduleDayConfig

    Working-hours configuration for a single weekday.

    is_working_dayIs Working Dayrequired

    Whether messages may be sent on this day.

    time_startTime Start

    Start of the working window, "HH:MM" (24h).

    Default value: 00:00
    time_endTime End

    End of the working window, "HH:MM" (24h).

    Default value: 00:00
    timezoneTimezone
    Default value: Europe/Moscow
    crm_id object

    Identifier of the matching record in the connected external CRM, if any.

    anyOf
    string
    static_meeting_link object
    anyOf
    string
    use_google_meet_linkUse Google Meet Link
    Default value: false
    create_crm_task_on_create_meetingCreate Crm Task On Create Meeting
    Default value: true
    create_crm_task_on_cancel_meetingCreate Crm Task On Cancel Meeting
    Default value: true
    service_selector_subagent_enabledService Selector Subagent Enabled
    Default value: false
    services object[]
  • Array [
    • idIdrequired

    The service's id at the calendar provider.

    nameNamerequired

    The service's display name.

    category_id object

    Optional category id the service belongs to.

    anyOf
    string
    llm_context object

    Optional description given to the LLM to help it pick this service.

    anyOf
    string
    is_enabled_in_calendarIs Enabled In Calendar

    Whether the service is currently bookable.

    Default value: true
  • ]
    • reminders object[]
  • Array [
    • step_numberStep Numberrequired
    before_minutesBefore Minutesrequired
    source objectrequired

    Specifies the content of a message to send, by reference to exactly one source — raw text, a prompt, a prepared message, a WABA template, or file(s).

    text object
    anyOf
    string
    prompt_id object
    anyOf
    integer
    prompt_version_id object
    anyOf
    integer
    prepared_message_id object
    anyOf
    integer
    waba_template_id object
    anyOf
    integer
    file_idsinteger[]
    caption object
    anyOf
    string
  • ]
    • created_atdate-timerequired

    Creation time (UTC, ISO 8601).

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[AgentIntegrationRead]
    {
      "items": [
        {
          "id": 0,
          "agent_id": 0,
          "integration_id": 0,
          "config": {
            "enabled": true,
            "max_lookahead_hours": 168,
            "meeting_duration_minutes": 30,
            "booking_lead_time_working_days": 0,
            "daily_booking_limit": 0,
            "slot_step_minutes": 5,
            "attach_crm_link_to_event": true,
            "title": "Meeting with Lead (auto)",
            "create_description_summary": true,
            "accounts": {},
            "service_selector_subagent_enabled": false,
            "services": [
              {
                "id": "string",
                "name": "string",
                "category_id": "string",
                "llm_context": "string",
                "is_enabled_in_calendar": true
              }
            ],
            "reminders": [
              {
                "step_number": 0,
                "before_minutes": 0,
                "source": {
                  "text": "string",
                  "prompt_id": 0,
                  "prompt_version_id": 0,
                  "prepared_message_id": 0,
                  "waba_template_id": 0,
                  "file_ids": [
                    0
                  ],
                  "caption": "string"
                }
              }
            ]
          },
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }