---
title: "List Systems"
method: GET
path: "/api/v1/systems"
tags: ["Systems"]
---

# List Systems

`GET /api/v1/systems`

Lists all systems. Note: In the Patchworks dashboard, a `system` is known as a `connector`.

## Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

## 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.

- logo
- logo_count
- logoExists
- systemType
- systemType_count
- systemTypeExists
- connectors
- connectors_count
- connectorsExists
- connectors.authenticationImplementation
- endpoints
- endpoints_count
- endpointsExists
- authenticationImplementations
- authenticationImplementations_count
- authenticationImplementationsExists
- authenticationImplementations.variables
- authenticationImplementations.authenticationType
- variables
- variables_count
- variablesExists
- systemTemplate
- systemTemplate_count
- systemTemplateExists
- systemTemplate.company
- systemTemplate.marketplaceCompany


## 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.

- name
- withUpdatable
- fromMarketplace
- fromApp


## Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

- systems.id
- systems.name
- systems.label
- systems.colour
- systems.system_template_id
- systems.version
- systems.version_name
- systems.system_type_id
- systems.protocol
- systems.date_format
- systems.help_link
- systems.created_at
- systems.updated_at
- systems.rate_limit_unit
- systems.rate_limit_duration


## 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[name]` string
- `filter[canonical_key]` string
- `filter[withUpdatable]` string
- `filter[fromMarketplace]` string
- `filter[fromApp]` string
- `filter[id]` string
- `filter[,]` string
- `include` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- SystemsListResponse
  - `data` Systems[]
    - `id` integer — Unique identifier
    - `name` string
    - `entity_type_id` integer
    - `direction` 'Send' | 'Receive'
    - `http_method` 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'
    - `label` string
    - `colour` 'blue' | 'blue_inverted' | 'cyan' | 'cyan_inverted' | 'gray' | 'gray_inverted' | 'green' | 'green_inverted' | 'orange' | 'orange_inverted' | 'pink' | 'pink_inverted' | 'purple' | 'purple_inverted' | 'red' | 'red_inverted' | 'yellow' | 'yellow_inverted'
    - `system_template_id` integer
    - `version` string
    - `version_name` string
    - `system_type_id` integer
    - `protocol` 'HTTP' | 'FTP' | 'SFTP' | 'FTPS' | 'S3' | 'MySQL' | 'PGSQL' | 'SQLSRV' | 'OCI'
    - `date_format` string
    - `help_link` string
    - `created_at` string
    - `updated_at` string
    - `rate_limit_unit` 'second' | 'minute' | 'hour' | 'day'
    - `rate_limit_duration` string
    - `endpoint` string
    - `method` string
    - `data_type` 'csv' | 'json' | 'txt' | 'xml'
    - `body_format` 'none' | 'form-data' | 'raw' | 'text'
    - `additional_endpoint_1` string
    - `additional_endpoint_2` string
    - `timeout` integer
    - `authentication_type_id` string
    - `returns_multiple_records` string
    - `pagination_method` 'Custom relative URI' | 'Link Header' | 'Next page token' | 'Next Page URL' | 'Page number parameter' | 'Limit offset' | 'default' | 'PeopleVox' | 'NetSuite SOAP' | 'GraphQL Cursor' | 'Database limit offset' | 'Script'
    - `schema` string
    - `endpoint_template_id` integer
    - `data_path` string
    - `raw_body` string
    - `deprecated_at` string
    - `disable_header_addition` string
    - `response_encoding` 'base64' | 'none'
    - `key` string
    - `value` string
    - `secret` string
    - `logo` string
    - `pre_script_version_id` string
    - `post_script_version_id` string
    - `canonical_key` object[]
    - `connectors` object[]
    - `system_type` object
    - `system_template` object[]
    - `authentication_implementations` object[]
    - `authentication_implementations_count` object[]
    - `endpoints` object[]
    - `variables` object[]
    - `updatable` string
    - `modified` string
    - `is_deployed` boolean
  - `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)