Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
partner_channels
Partner Channels

List Partner Channels

List Partner Channels

get/partner_channels

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, path or partner_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are partner_id and workspace_id. Valid field combinations are [ workspace_id, partner_id ].

Response

A list of PartnerChannels objects.

idinteger

The unique ID of the Partner Channel.

workspace_idinteger

ID of the Workspace associated with this Partner Channel.

partner_idinteger

ID of the Partner this Channel belongs to.

partner_channel_template_idinteger

ID of the Partner Channel Template that manages this Channel, if any.

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_pathstring

Optional route path for files uploaded by the Partner.

to_partner_route_pathstring

Optional route path for files delivered to the Partner.

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 folder name after Channel override and default.

effective_from_partner_folder_namestring

Resolved from-Partner folder name after Channel override and default.

channel_pathstring

Resolved Channel folder path.

to_partner_folder_pathstring

Resolved to-Partner folder path.

from_partner_folder_pathstring

Resolved from-Partner folder path.

Example response

[
  {
    "id": 1,
    "partner_id": 1,
    "partner_channel_template_id": 1,
    "path": "claims/medical",
    "to_partner_folder_name": "outgoing",
    "from_partner_folder_name": "incoming",
    "from_partner_route_path": "processing/from-partner",
    "to_partner_route_path": "delivery/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",
    "channel_path": "partners/acme/claims/medical",
    "to_partner_folder_path": "partners/acme/claims/medical/outgoing",
    "from_partner_folder_path": "partners/acme/claims/medical/incoming"
  }
]