List 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