Skip to content
Praxrr

Get one TRaSH cached entity

GET
/trash-guide/sources/{id}/entities/{trashId}
curl --request GET \
  --url 'https://example.com/api/v1/trash-guide/sources/1/entities/example?type=custom_format'

Returns a single TRaSH entity from a synced source cache by trashId.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

TRaSH source ID

trashId
required
string

TRaSH entity ID (32 lowercase hex chars)

Query Parameters

Section titled “Query Parameters”
type
required
string
Allowed values: custom_format custom_format_group quality_profile quality_size naming

TRaSH entity type

Responses

Section titled “Responses”

200

Section titled “200”

TRaSH cached entity

Media typeapplication/json
object
source
required
object
type
required
string
Allowed values: trash
id
required
integer
name
required
string
arrType
required
string
Allowed values: radarr sonarr
trashId
required
string
type
required
string
Allowed values: custom_format custom_format_group quality_profile quality_size naming
name
required
string
filePath
required
string
fetchedAt
required
string format: date-time
entity
required
object
key
additional properties
any
scores
object
key
additional properties
number
group
integer
nullable
Example
{
  "source": {
    "type": "trash",
    "arrType": "radarr"
  },
  "type": "custom_format"
}

400

Section titled “400”

Missing or invalid source/id/type parameter

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

404

Section titled “404”

Source or TRaSH entity not found

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

422

Section titled “422”

Invalid entity type

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to read TRaSH entity cache

Media typeapplication/json
object
error
required
string
Examplegenerated
{
  "error": "example"
}