Skip to content
Navigation

List the connections

The organization's integration connections (SURA, Visoft, its Agenda, custom servers) with the tools each offers an agent and their version.

  • Scopes: any one of account:connections:read, account:connections:write, account:organizations:read
  • Credentials: an API key, a client-credentials token or a person's access token
  • Effect: read-only; safe to retry
  • Limits: response up to 4 MB
  • CLI: arbol account connections list · MCP tool: account_connections_list
GET
https://api.getarbol.com/v1/account/connections

Authorization

  • Authorization
    string
    required
    Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with any one of the scopes account:connections:read, account:connections:write, account:connections:operate, account:organizations:read. Get an API key.

Query parameters

  • cursor
    optional
    string

    Opaque cursor returned by pageInfo; omit it to request the first page.

  • direction
    optional
    forward
    or
    backward

    Direction to traverse the stable keyset ordering from the supplied cursor.

    default: "forward"
  • limit
    optional
    integer

    Maximum items returned in one page. Defaults to 25; larger reads require another cursor.

    maximum: 100 · minimum: 1 · default: 25
  • tag
    optional
    postconsulta
    or
    facturacion

    The tag.

Returns

200

Successful operation.

JSON
  • success
    true
    required
  • data
    object
    required
    • data
      array of
      object
      required

      Items admitted by this resource contract within the verified organization.

      • id
        string
        required

        A connection's id: con_ and 26 characters, stable and unique across the platform.

        pattern: ^con_[0-7][0-9a-hjkmnp-tv-z]{25}$
      • kind
        arbol
        or
        custom
        required
      • integration
        string
        required

        sura, visoft, agenda, or a custom server's name.

      • name
        string
        required
      • status
        active
        or
        disabled
        or
        failed
        required

        active: agents may use it. disabled: turned off. failed: agents cannot use it until Arbol's team reviews it.

      • summary
        string | null
        required
      • toolsVersion
        string
        required

        The release version (arbol) or the SHA-256 of the stored tool list (custom).

      • tools
        array of
        object
        required
        • name
          string
          required

          The tool name an agent calls: the MCP tool name, or the OpenAPI operationId.

          maxLength: 64 · minLength: 1
        • description
          string
          required
          maxLength: 8000
        • input
          object
          required

          The tool's input, as a JSON Schema object.

        • effect
          read
          or
          write
          required

          read changes nothing; write may.

        • runtimeInputs
          optional
          array of
          connectionId
          or
          channel
          or
          conversationUrl
        • operation
          optional
          string

          The published operation (arbol only): sura.appointments.create.

          maxLength: 200
        • writesThrough
          optional
          array of
          string

          The Arbol integrations this tool writes through (custom only): Raíz fences them jointly.

          pattern: ^[a-z][a-z0-9-]{1,63}$
        • rest
          optional
          object

          The REST request the tool is: its method and path template.

          • method
            GET
            or
            POST
            or
            PUT
            or
            PATCH
            or
            DELETE
            required
          • path
            string
            required
            maxLength: 1000
        • capabilities
          optional
          object

          The scopes its caller needs (arbol only), as the release admits it: any one of them, or all.

          • match
            any
            or
            all
            required
          • scopes
            array of
            string
            required
            maxLength: 128 · minLength: 1
      • server
        object | null
        required

        The organization's own server, where its tools are called.

        • transport
          http
          or
          mcp
          required
        • url
          string
          required

          Where the tools' requests go: the HTTP server's base, or the MCP endpoint.

        • fileArgument
          string | null
          required

          The tool argument that receives files, or null.

      • errorCode
        string | null
        required
      • updatedAt
        string | null
        required
      • tags
        optional
        array of
        postconsulta
        or
        facturacion

        The workflow labels assigned to this connection.

      • skills
        optional
        array of
        object

        A custom server's skills: procedures its document publishes beside its tools.

        • name
          string
          required
          maxLength: 64 · minLength: 1 · pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
        • description
          string
          required

          One line: what the procedure achieves and when to load it.

          maxLength: 1024 · minLength: 1 · pattern: ^[^\r\n]+$
        • instructions
          string
          required

          The Markdown procedure.

          maxLength: 30000 · minLength: 1
    • object
      string
      required

      Discriminator for a resource list response.

    • pageInfo
      object
      required

      Opaque navigation cursors for this page’s stable keyset order.

      • hasNextPage
        boolean
        required

        Whether a later page exists in the current ordering.

      • hasPreviousPage
        boolean
        required

        Whether an earlier page exists in the current ordering.

      • nextCursor
        string | null
        required

        Opaque cursor for the next page, or null when there is none.

      • previousCursor
        string | null
        required

        Opaque cursor for the previous page, or null when there is none.

  • error
    unknown
    required
  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

400

INVALID_INPUT: The request does not match the published schema.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request does not match the published schema.

    • code
      INVALID_INPUT
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required
      • issues
        optional
        array of
        object
        • path
          string
          required

          RFC 6901 JSON Pointer to the refused field; empty for the whole input.

          maxLength: 256
        • message
          string
          required
          maxLength: 256
  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

401

UNAUTHORIZED: A valid access token is required.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    A valid access token is required.

    • code
      UNAUTHORIZED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

403

FORBIDDEN: The token does not authorize this operation.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The token does not authorize this operation.

    • code
      FORBIDDEN
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request rate limit was exceeded. Try again later.

    • code
      RATE_LIMITED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

500

INTERNAL_ERROR: The service could not complete the operation.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The service could not complete the operation.

    • code
      INTERNAL_ERROR
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The operation may have been applied; check its result before repeating it.

    • code
      OUTCOME_UNKNOWN
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The upstream service could not complete the request.

    • code
      UPSTREAM_UNAVAILABLE
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The upstream service did not respond before its deadline.

    • code
      UPSTREAM_TIMEOUT
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

Escribe para buscar…

↑↓ navegar↵ seleccionarEsc cerrar