FIfiles
partner_channel_templates
Partner Channel Templates

List Partner Channel Templates

Changed on

List Partner Channel Templates

get/partner_channel_templates

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/partner_channel_templates
  • Auth
    none declared

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id and name.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id.

Response

A list of PartnerChannelTemplates objects.

idinteger

The unique ID of the Partner Channel Template.

workspace_idinteger

ID of the Workspace associated with this Partner Channel Template.

direction'two_way' | 'to_partner' | 'from_partner'

Channel directions. two_way enables both directions, to_partner enables outgoing downloads, and from_partner enables incoming uploads.

use_channel_rootboolean

Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.

namestring

The name of the Partner Channel Template.

pathstring

Channel path relative to the Partner root folder.

to_partner_folder_namestring

Optional Channel-level to-Partner folder name override.

from_partner_folder_namestring

Optional Channel-level from-Partner folder name override.

from_partner_route_path_patternstring

Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.

to_partner_route_path_patternstring

Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.

to_partner_managed_folder_pathsstring[]

Managed folder paths inside the to-Partner folder.

from_partner_managed_folder_pathsstring[]

Managed folder paths inside the from-Partner folder.

effective_to_partner_folder_namestring

Resolved to-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

effective_from_partner_folder_namestring

Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

Example response

[
  {
    "id": 1,
    "direction": "two_way",
    "name": "Claims Template",
    "path": "claims/medical",
    "to_partner_folder_name": "outgoing",
    "from_partner_folder_name": "incoming",
    "from_partner_route_path_pattern": "processing/{{partner_name}}/from-partner",
    "to_partner_route_path_pattern": "delivery/{{partner_name}}/to-partner",
    "to_partner_managed_folder_paths": [
      "reports/monthly"
    ],
    "from_partner_managed_folder_paths": [
      "claims/received"
    ],
    "effective_to_partner_folder_name": "outgoing",
    "effective_from_partner_folder_name": "incoming"
  }
]

Changes