---
title: "List Connectors"
method: GET
path: "/api/v1/connectors"
tags: ["Connectors"]
---

# List Connectors

`GET /api/v1/connectors`

Retrieves a paginated list of connectors. Can be filtered by `canonical_key`, `system`, and other criteria. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.

## Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

- authenticationImplementation
- authenticationImplementation_count
- authenticationImplementationExists
- authenticationImplementation.authenticationType
- authenticationImplementation.system
- authenticationImplementation.system.logo
- authenticationImplementation.endpoints
- authenticationImplementation.endpoints.filters
- authenticationImplementation.endpoints.endpointSchema
- authenticationImplementation.endpoints.system
- authenticationImplementation.endpoints.system.logo
- authenticationImplementation.endpoints.entityType
- authenticationImplementation.endpoints.fieldTags
- authenticationImplementation.system.systemType
- variables
- variables_count
- variablesExists
- authenticationImplementation.endpoints.variables
- certificate
- certificate_count
- certificateExists
- certificate.user


## Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

- forSystemTemplate
- forSession




## Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

- name

## Query parameters

- `filter[canonical_key]` string
- `filter[forSystemTemplate]` string
- `filter[system]` string
- `filter[system_template_id]` string
- `filter[forSession]` string
- `filter[platformSession]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- ConnectorsListResponse
  - `data` Connectors[]
    - `id` integer — Unique identifier
    - `authentication_implementation_id` string
    - `timezone` string
    - `date_format` string
    - `rate_limit_unit` 'second' | 'minute' | 'hour' | 'day'
    - `rate_limit_duration` integer
    - `connection_pool_id` integer
    - `variables` string
    - `session_id` string
    - `platform_app_key` string
    - `certificate_id` string
    - `type` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `name` string
    - `authentication_implementation` object[]
    - `system` string
    - `certificate` string
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)