Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
partners
Partners

List Partners

List Partners

get/partners

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

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

Response

A list of Partners objects.

allow_bypassing_2fa_policiesboolean

Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.

allowed_ipsstring

A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.

allow_credential_changesboolean

Allow Partner Admins to change or reset credentials for users belonging to this Partner.

allow_providing_gpg_keysboolean

Allow Partner Admins to provide GPG keys.

allow_user_creationboolean

Allow Partner Admins to create users.

cc_emails_to_responsible_partyboolean

When true, emails sent to Partner users are copied to the responsible User or Group.

idinteger

The unique ID of the Partner.

ai_assistant_personality_idinteger

AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.

workspace_idinteger

ID of the Workspace associated with this Partner.

namestring

The name of the Partner.

notesstring

Notes about this Partner.

partner_admin_idsinteger[]

Array of User IDs that are Partner Admins for this Partner.

partner_channel_template_idinteger

ID of the Partner Channel Template assigned to this Partner.

partnership_role'host' | 'guest' | 'host_and_guest'

This site's role in Partner Site relationships for this Partner. Can be host, guest, host_and_guest, or null.

responsible_group_idinteger

ID of the Group responsible for this Partner.

responsible_user_idinteger

ID of the User responsible for this Partner.

root_folderstring

The root folder path for this Partner.

show_partner_channel_home_pageboolean

Show Partner users a simplified home page built from this Partner's Channels.

tagsstring

Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.

user_idsinteger[]

Array of User IDs that belong to this Partner.

Example response

[
  {
    "allowed_ips": "10.0.0.0/8\n127.0.0.1",
    "id": 1,
    "ai_assistant_personality_id": 1,
    "workspace_id": 1,
    "name": "Acme Corp",
    "notes": "This is a note about the partner.",
    "partner_admin_ids": [
      1,
      2,
      3
    ],
    "partner_channel_template_id": 1,
    "partnership_role": "host",
    "responsible_group_id": 1,
    "responsible_user_id": 1,
    "root_folder": "/AcmeCorp",
    "tags": "example",
    "user_ids": [
      1,
      2,
      3
    ]
  }
]