Partners API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• GET /partners — Retrieve partners
• POST /partners — Create a partner
• GET /partners/locked-notice — Get the Locked partner items notice
• PUT /partners/locked-notice — Dismiss the Locked partner items notice
• DELETE /partners/{id} — Remove a partner
• POST /partners/{id} — Create a partner
• PUT /partners/{id} — Update a partner

Retrieve partners

GET /api/partners

Retrieve a list of partners with whom assets are shared.

Authentication: API key. Permission: partner.read.

Parameters

Name	Where	Required	Description
direction	query	Yes

Parameter types, defaults and constraints

Field definitions: PartnerDirection

[
  {
    "name": "direction",
    "required": true,
    "in": "query",
    "schema": {
      "$ref": "#/components/schemas/PartnerDirection"
    }
  }
]

Responses

Field definitions: PartnerResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/PartnerResponseDto"
          },
          "type": "array"
        }
      }
    },
    "description": ""
  }
}

Create a partner

POST /api/partners

Create a new partner to share assets with.

Authentication: API key. Permission: partner.create.

Request body

Required.

Field definitions: PartnerCreateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/PartnerCreateDto"
    }
  }
}

Responses

Field definitions: PartnerResponseDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PartnerResponseDto"
        }
      }
    },
    "description": ""
  }
}

Get the Locked partner items notice

GET /api/partners/locked-notice

Whether to show the one-time notice that Locked items arrived from a partner and stay hidden until you set a PIN.

Authentication: API key. Permission: partner.read.

Responses

Field definitions: PartnerLockedNoticeResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PartnerLockedNoticeResponseDto"
        }
      }
    },
    "description": ""
  }
}

Dismiss the Locked partner items notice

PUT /api/partners/locked-notice

Dismisses the one-time notice about Locked partner items for good. The items stay locked.

Authentication: API key. Permission: partner.update.

Responses

Field definitions: PartnerLockedNoticeResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PartnerLockedNoticeResponseDto"
        }
      }
    },
    "description": ""
  }
}

Remove a partner

DELETE /api/partners/{id}

Stop sharing assets with a partner.

Authentication: API key. Permission: partner.delete.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

{
  "204": {
    "description": ""
  }
}

Create a partner

POST /api/partners/{id}

Create a new partner to share assets with.

Deprecated. Avoid this operation in new integrations; use the replacement supported by your server release.

Authentication: API key. Permission: partner.create.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

Field definitions: PartnerResponseDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PartnerResponseDto"
        }
      }
    },
    "description": ""
  }
}

Update a partner

PUT /api/partners/{id}

A partnership has no settings left (): partners receive their own copies and locations are always shared. Kept for older clients; returns the partner who shares with the user.

Authentication: API key. Permission: partner.update.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: PartnerUpdateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/PartnerUpdateDto"
    }
  }
}

Responses

Field definitions: PartnerResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PartnerResponseDto"
        }
      }
    },
    "description": ""
  }
}