Integration compatibility API

GET/auth/keysIntegration compatibility: keysread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_keys_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/auth/keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/auth/keysIntegration compatibility: mint_keyread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_mint_key_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/auth/keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/Auth/KeysIntegration compatibility: keysread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_keys

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Auth/Keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/Auth/KeysIntegration compatibility: mint_keyread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_mint_key
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Auth/Keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/displaypreferences/usersettingsIntegration compatibility: display_preferencesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_display_preferences_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/displaypreferences/usersettings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/DisplayPreferences/usersettingsIntegration compatibility: display_preferencesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_display_preferences

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/DisplayPreferences/usersettings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/itemsIntegration compatibility: itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_items_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/ItemsIntegration compatibility: itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_items

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/items/{id}/images/{type}Integration compatibility: imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_image_lower

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/items/{id}/images/{type}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Items/{id}/Images/{type}Integration compatibility: imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_image

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Items/{id}/Images/{type}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/items/{id}/images/{type}/{index}Integration compatibility: indexed_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_indexed_image_lower

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`index`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/items/{id}/images/{type}/{index}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Items/{id}/Images/{type}/{index}Integration compatibility: indexed_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_indexed_image

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`index`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Items/{id}/Images/{type}/{index}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/items/{id}/playbackinfoIntegration compatibility: media_inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_info_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/items/{id}/playbackinfo" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Items/{id}/PlaybackInfoIntegration compatibility: media_inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_info

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Items/{id}/PlaybackInfo" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/items/{id}/refreshIntegration compatibility: refresh_itemlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_refresh_item_lower
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/items/{id}/refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Items/{id}/RefreshIntegration compatibility: refresh_itemlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_refresh_item
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Items/{id}/Refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/items/latestIntegration compatibility: latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_latest_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/items/latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Items/LatestIntegration compatibility: latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_latest

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Items/Latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/library/media/updatedIntegration compatibility: media_updatedlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_updated_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/library/media/updated" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Library/Media/UpdatedIntegration compatibility: media_updatedlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_updated
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Library/Media/Updated" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/library/mediafoldersIntegration compatibility: media_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_folders_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/library/mediafolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Library/MediaFoldersIntegration compatibility: media_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_folders

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Library/MediaFolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/library/refreshIntegration compatibility: untargeted_refreshlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_untargeted_refresh_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/library/refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Library/RefreshIntegration compatibility: untargeted_refreshlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_untargeted_refresh
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Library/Refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/library/virtualfoldersIntegration compatibility: virtual_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_virtual_folders_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/library/virtualfolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Library/VirtualFoldersIntegration compatibility: virtual_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_virtual_folders

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Library/VirtualFolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/auth/keysIntegration compatibility: keysread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_keys_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/auth/keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/auth/keysIntegration compatibility: mint_keyread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_mint_key_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/auth/keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/Auth/KeysIntegration compatibility: keysread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_keys_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Auth/Keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/Auth/KeysIntegration compatibility: mint_keyread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_mint_key_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Auth/Keys" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/displaypreferences/usersettingsIntegration compatibility: display_preferencesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_display_preferences_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/displaypreferences/usersettings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/DisplayPreferences/usersettingsIntegration compatibility: display_preferencesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_display_preferences_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/DisplayPreferences/usersettings" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/itemsIntegration compatibility: itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_items_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/ItemsIntegration compatibility: itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_items_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/items/{id}/images/{type}Integration compatibility: imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_image_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/items/{id}/images/{type}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Items/{id}/Images/{type}Integration compatibility: imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_image_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Items/{id}/Images/{type}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/items/{id}/images/{type}/{index}Integration compatibility: indexed_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_indexed_image_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`index`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/items/{id}/images/{type}/{index}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Items/{id}/Images/{type}/{index}Integration compatibility: indexed_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_indexed_image_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`type`required	path	`string`
`index`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Items/{id}/Images/{type}/{index}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/items/{id}/playbackinfoIntegration compatibility: media_inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_info_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/items/{id}/playbackinfo" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Items/{id}/PlaybackInfoIntegration compatibility: media_inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_info_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Items/{id}/PlaybackInfo" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/items/{id}/refreshIntegration compatibility: refresh_itemlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_refresh_item_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/items/{id}/refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Items/{id}/RefreshIntegration compatibility: refresh_itemlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_refresh_item_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Items/{id}/Refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/items/latestIntegration compatibility: latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_latest_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/items/latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Items/LatestIntegration compatibility: latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_latest_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Items/Latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/library/media/updatedIntegration compatibility: media_updatedlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_updated_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/library/media/updated" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Library/Media/UpdatedIntegration compatibility: media_updatedlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_updated_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Library/Media/Updated" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/library/mediafoldersIntegration compatibility: media_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_folders_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/library/mediafolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Library/MediaFoldersIntegration compatibility: media_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_media_folders_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Library/MediaFolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/library/refreshIntegration compatibility: untargeted_refreshlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_untargeted_refresh_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/library/refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Library/RefreshIntegration compatibility: untargeted_refreshlibrary

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_untargeted_refresh_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Library/Refresh" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/library/virtualfoldersIntegration compatibility: virtual_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_virtual_folders_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/library/virtualfolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Library/VirtualFoldersIntegration compatibility: virtual_foldersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_virtual_folders_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Library/VirtualFolders" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/notifications/adminIntegration compatibility: notifyadmin

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_notify_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/notifications/admin" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Notifications/AdminIntegration compatibility: notifyadmin

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_notify_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Notifications/Admin" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/pluginsIntegration compatibility: pluginsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_plugins_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/plugins" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/PluginsIntegration compatibility: pluginsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_plugins_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Plugins" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/sessionsIntegration compatibility: sessionsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_sessions_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/SessionsIntegration compatibility: sessionsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_sessions_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/sessions/{id}/playing/{command}Integration compatibility: transportplayback

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_transport_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`command`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/sessions/{id}/playing/{command}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Sessions/{id}/Playing/{command}Integration compatibility: transportplayback

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_transport_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`command`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Sessions/{id}/Playing/{command}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/mediabrowser/shows/{id}/episodesIntegration compatibility: episodesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_episodes_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/shows/{id}/episodes" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Shows/{id}/EpisodesIntegration compatibility: episodesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_episodes_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Shows/{id}/Episodes" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/shows/{id}/seasonsIntegration compatibility: seasonsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_seasons_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/shows/{id}/seasons" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Shows/{id}/SeasonsIntegration compatibility: seasonsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_seasons_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Shows/{id}/Seasons" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/system/configurationIntegration compatibility: configurationread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_configuration_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/system/configuration" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/System/ConfigurationIntegration compatibility: configurationread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_configuration_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/System/Configuration" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/system/infoIntegration compatibility: inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_info_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/system/info" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/System/InfoIntegration compatibility: inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_info_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/System/Info" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/system/info/publicIntegration compatibility: public_infoopen

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_public_info_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/system/info/public"

GET/mediabrowser/System/Info/PublicIntegration compatibility: public_infoopen

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_public_info_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/System/Info/Public"

GET/mediabrowser/usersIntegration compatibility: usersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_users_legacy_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/UsersIntegration compatibility: usersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_users_legacy

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}Integration compatibility: userread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}Integration compatibility: userread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}/images/primaryIntegration compatibility: user_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_image_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}/images/primary" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}/Images/PrimaryIntegration compatibility: user_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_image_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}/Images/Primary" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}/itemsIntegration compatibility: user_itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_items_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}/items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}/ItemsIntegration compatibility: user_itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_items_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}/Items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}/items/{item}Integration compatibility: user_itemread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_item_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`item`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}/items/{item}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}/Items/{item}Integration compatibility: user_itemread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_item_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`item`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}/Items/{item}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}/items/latestIntegration compatibility: user_latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_latest_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}/items/latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}/Items/LatestIntegration compatibility: user_latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_latest_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}/Items/Latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/users/{id}/viewsIntegration compatibility: viewsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_views_legacy_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/users/{id}/views" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/mediabrowser/Users/{id}/ViewsIntegration compatibility: viewsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_views_legacy

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/mediabrowser/Users/{id}/Views" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/mediabrowser/users/authenticatebynameIntegration compatibility: authenticatesession

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_authenticate_legacy_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/users/authenticatebyname" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/mediabrowser/Users/AuthenticateByNameIntegration compatibility: authenticatesession

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_authenticate_legacy
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/mediabrowser/Users/AuthenticateByName" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/notifications/adminIntegration compatibility: notifyadmin

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_notify_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/notifications/admin" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Notifications/AdminIntegration compatibility: notifyadmin

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_notify
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Notifications/Admin" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/pluginsIntegration compatibility: pluginsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_plugins_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/plugins" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/PluginsIntegration compatibility: pluginsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_plugins

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Plugins" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/sessionsIntegration compatibility: sessionsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_sessions_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/SessionsIntegration compatibility: sessionsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_sessions

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/sessions/{id}/playing/{command}Integration compatibility: transportplayback

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_transport_lower
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`command`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/sessions/{id}/playing/{command}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Sessions/{id}/Playing/{command}Integration compatibility: transportplayback

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_transport
Max body: 1 MiB

Parameters

Name	In	Type
`id`required	path	`string`
`command`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Sessions/{id}/Playing/{command}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

GET/shows/{id}/episodesIntegration compatibility: episodesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_episodes_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/shows/{id}/episodes" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Shows/{id}/EpisodesIntegration compatibility: episodesread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_episodes

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Shows/{id}/Episodes" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/shows/{id}/seasonsIntegration compatibility: seasonsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_seasons_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/shows/{id}/seasons" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Shows/{id}/SeasonsIntegration compatibility: seasonsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_seasons

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Shows/{id}/Seasons" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/system/configurationIntegration compatibility: configurationread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_configuration_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/system/configuration" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/System/ConfigurationIntegration compatibility: configurationread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_configuration

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/System/Configuration" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/system/infoIntegration compatibility: inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_info_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/system/info" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/System/InfoIntegration compatibility: inforead

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_info

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/System/Info" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/system/info/publicIntegration compatibility: public_infoopen

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_public_info_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/system/info/public"

GET/System/Info/PublicIntegration compatibility: public_infoopen

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_public_info

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/System/Info/Public"

GET/usersIntegration compatibility: usersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_users_lower

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/UsersIntegration compatibility: usersread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_users

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}Integration compatibility: userread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}Integration compatibility: userread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}/images/primaryIntegration compatibility: user_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_image_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}/images/primary" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}/Images/PrimaryIntegration compatibility: user_imageread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_image

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}/Images/Primary" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}/itemsIntegration compatibility: user_itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_items_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}/items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}/ItemsIntegration compatibility: user_itemsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_items

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}/Items" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}/items/{item}Integration compatibility: user_itemread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_item_lower

Parameters

Name	In	Type
`id`required	path	`string`
`item`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}/items/{item}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}/Items/{item}Integration compatibility: user_itemread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_item

Parameters

Name	In	Type
`id`required	path	`string`
`item`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}/Items/{item}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}/items/latestIntegration compatibility: user_latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_latest_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}/items/latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}/Items/LatestIntegration compatibility: user_latestread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_user_latest

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`integer \| ""`0–5000000
`Limit`	query	`integer \| ""`0–5000000
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}/Items/Latest" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/users/{id}/viewsIntegration compatibility: viewsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_views_lower

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/users/{id}/views" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/Users/{id}/ViewsIntegration compatibility: viewsread

Audience: Integrations · Tool compatibility
Authorization: Dedicated integration credential; follow the tool setup guide for its connection and grant.
OpenAPI operation ID: compat_views

Parameters

Name	In	Type
`id`required	path	`string`
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/Users/{id}/Views" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/users/authenticatebynameIntegration compatibility: authenticatesession

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_authenticate_lower
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/users/authenticatebyname" \
  -H "Content-Type: application/json" \
  -d 'null'

POST/Users/AuthenticateByNameIntegration compatibility: authenticatesession

Audience: Integrations · Tool compatibility
Authorization: No credential needed
OpenAPI operation ID: compat_authenticate
Max body: 1 MiB

Parameters

Name	In	Type
`App`	query	`string`
`app`	query	`string`
`userId`	query	`string`
`UserId`	query	`string`
`userid`	query	`string`
`ids`	query	`string`
`Ids`	query	`string`
`parentId`	query	`string`
`ParentId`	query	`string`
`fields`	query	`string`
`Fields`	query	`string`
`recursive`	query	`string`
`Recursive`	query	`string`
`includeItemTypes`	query	`string`
`IncludeItemTypes`	query	`string`
`excludeItemTypes`	query	`string`
`ExcludeItemTypes`	query	`string`
`years`	query	`string`
`Years`	query	`string`
`sortBy`	query	`string`
`SortBy`	query	`string`
`sortOrder`	query	`string`
`SortOrder`	query	`string`
`startIndex`	query	`string`
`StartIndex`	query	`string`
`limit`	query	`string`
`Limit`	query	`string`
`searchTerm`	query	`string`
`SearchTerm`	query	`string`
`anyProviderIdEquals`	query	`string`
`AnyProviderIdEquals`	query	`string`
`isMissing`	query	`string`
`IsMissing`	query	`string`
`excludeLocationTypes`	query	`string`
`ExcludeLocationTypes`	query	`string`
`collapseBoxSetItems`	query	`string`
`CollapseBoxSetItems`	query	`string`
`enableTotalRecordCount`	query	`string`
`EnableTotalRecordCount`	query	`string`
`minDateCreated`	query	`string`
`MinDateCreated`	query	`string`
`season`	query	`string`
`Season`	query	`string`
`seasonId`	query	`string`
`SeasonId`	query	`string`
`metadataRefreshMode`	query	`string`
`MetadataRefreshMode`	query	`string`
`imageRefreshMode`	query	`string`
`ImageRefreshMode`	query	`string`
`replaceAllMetadata`	query	`string`
`ReplaceAllMetadata`	query	`string`
`replaceAllImages`	query	`string`
`ReplaceAllImages`	query	`string`
`refreshRecursive`	query	`string`
`RecursiveRefresh`	query	`string`
`client`	query	`string`
`Client`	query	`string`
`maxWidth`	query	`string`
`MaxWidth`	query	`string`
`maxHeight`	query	`string`
`MaxHeight`	query	`string`
`fillWidth`	query	`string`
`FillWidth`	query	`string`
`quality`	query	`string`
`Quality`	query	`string`
`blur`	query	`string`
`Blur`	query	`string`
`tag`	query	`string`
`Tag`	query	`string`
`seekPositionTicks`	query	`string`
`SeekPositionTicks`	query	`string`
`playCommand`	query	`string`
`PlayCommand`	query	`string`
`itemIds`	query	`string`
`ItemIds`	query	`string`

Request body application/json · required

Example

null

Schema

any

Responses

200Successapplication/json

Example

null

Schema

any

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinternalinsufficient_scopesession_requiredadministration_unavailableauthentication_busycredential_limitrate_limitedinvalid_cursorcursor_expiredstale_continuationrevision_requiredrevision_mismatchsession_endedsubtitle_unavailablesubtitle_not_foundsubtitle_renderer_platform_unsupportedsubtitle_renderer_configurationsubtitle_conflictsubtitle_operation_conflictsubtitle_capacitysubtitle_unsupportedsubtitle_invalid_inputsubtitle_provider_not_configuredsubtitle_provider_key_rejectedsubtitle_provider_sign_in_failedsubtitle_provider_sign_in_requiredsubtitle_provider_quotasubtitle_provider_busydatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/Users/AuthenticateByName" \
  -H "Content-Type: application/json" \
  -d 'null'