---
title: "List connections"
method: GET
path: "/connectivity/v2beta/connections"
tags: ["Connections"]
---

# List connections

`GET /connectivity/v2beta/connections`

Returns a list of connections. For further details on Pagination, see general section above.

## Query parameters

- `limit` integer
- `token` string

## Response `200`

List of connections.

- object
  - `items` Connection[], required — A list of resources.
    - `id` string, required — Unique resource identifier.
    - `organizationId` string, required — Unique resource identifier for an Organization.
    - `connectionTypeId` string, required — ID of the associated connection type.
    - `thirdPartyId` string, required — ID of the associated third-party.
    - `affiliationId` string, required — ID of the affiliation. An affiliation is and describes the relationship between the legal entity owning this connection.
    - `alias` string — Optional alias of the connection
    - `configuration` ConnectionConfiguration, required
      - `thirdParty` ThirdPartyConfiguration, required
        - `environment` string, required — The environment of the third-party. This is intentionally not an enum, as it is up to the third-party to define their environments. However, we do have a common one: "production".
      - `reports` ReportsConfiguration, required
        - `transport` ReportsTransportConfiguration, required
          - `mode` 'ATLAR_INITIATED' | 'THIRDPARTY_INITIATED' | 'DISABLED', required
      - `transport` TransportConfiguration, required
        - `requiredSignatures` integer, required
        - `disabled` boolean, required
        - `signatureScope` 'ALL' | 'CUSTOMER_UPLOADED_ONLY' — Controls which instructions require signatures. ALL: RequiredSignatures applies to all instructions (default). CUSTOMER_UPLOADED_ONLY: RequiredSignatures only applies to customer-uploaded instructions; system-generated instructions auto-release.
    - `deprecatedConfiguration` DeprecatedConnectionConfiguration, required
      - `disabledTransport` boolean, required — general configuration for transport
      - `maxBatchSize` integer, required — push scheduling config - maximum batch size
      - `pushSchedule` SchedulingSchedule, required
        - `frequency` 'DEFAULT' | 'EVERY_15M' | 'HOURLY' | 'DISABLED', required — The frequency of the schedule
        - `schedule` integer[] — Schedule integers (0-23 for HOURLY, 0-3 for EVERY_15M)
        - `location` string — The timezone location (e.g. "Europe/London")
        - `exclusions` Exclusion[] — Time periods to exclude from the schedule
          - `dayOfWeek` integer — Day of week (1 = Monday, 7 = Sunday). 0 or omitted means the exclusion is not restricted to a weekday. Mutually exclusive with date.
          - `date` string, date — `full-date` notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, `2017-07-21`.
          - `from` string, time, required — Start time of exclusion (HH:MM:SS)
          - `to` string, time, required — End time of exclusion (HH:MM:SS)
      - `pushPriority` integer, required — push scheduling priority
      - `bypassTimeToSchedulePaymentCheck` boolean — if true, bypasses all timeToSchedulePayment checks and schedules payments immediately
      - `fetchFrequency` 'DEFAULT' | 'EVERY_15M' | 'HOURLY' | 'DISABLED' — DEPRECATED - fetch scheduling frequency
      - `fetchSchedules` object, required — fetch scheduling configuration mapped by fetch type
      - `fetchDataTypes` string[], required — fetch data types configuration
      - `ebicsFetchConfig` object, required — EBICS fetcher configuration
        - `eodyFetchTypesOverride` string[]
        - `interimFetchTypesOverride` string[]
      - `connectionPool` ConnectionPool, required
        - `forwards` Forward[] — List of forwarding rules
          - `matches` Matches, required
            - `bic` string[] — List of BIC identifiers
            - `vendor` ThirdPartyVendor[] — List of third-party vendors
          - `affiliationId` string — The ID of the affiliation to forward to
          - `canInitiatePayments` boolean — Whether this forward can be used to initiate payments
      - `thirdParty` object, required — third party configuration
        - `env` string
      - `ignoredData` unknown[], required — ignored data configuration
        - unknown
      - `transport` object
        - `requiredSignatures` integer
        - `signatureScope` 'ALL' | 'CUSTOMER_UPLOADED_ONLY'
    - `capabilities` Capabilities, required
    - `lifecycleState` 'UNDER_DEVELOPMENT' | 'LIVE', required — The lifecycle state of the connection.
    - `inactive` boolean, required — True if connection has been inactivated
    - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update.
    - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update.
    - `created` string, date-time, required — Time at which the resource was created.
    - `updated` string, date-time, required — Time at which the resource was last updated.
  - `nextToken` string, required — Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.
  - `token` string, required — The pagination token that was used for this request. The value will be an empty string if no `token` query parameter was provided with the request.
  - `limit` integer, required — The page limit that was used for this request.

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/atlar/apis/atlar-api-v2.md) · [All operations](https://skmtc.net/atlar/apis/atlar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlar/atlar-api-v2/revisions/9c5e194ccf5d/schema)