List folder referrers

Lists the domains registered directly on a folder.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

GET /library/{library_id}?action=folder_refer

Lists the domains registered directly on a folder. Domains inherited from parent folders are not included here — use List inherited folder referrers for those.

🚧

action=folder_refer is required

Both action and folder_id are required query parameters. Without action, this path returns the library details instead of a referrer list.

📘

Authorization

Requires a valid API token in the Authorization header (without Bearer prefix). The library_id must belong to the authenticated user.

HTTP Method & Path

GET /library/{library_id}?action=folder_refer&folder_id={folder_id}

Base URL: https://api-v2.pandavideo.com.br

Authentication Requirements

HeaderValue
AuthorizationYour Panda API token (no Bearer prefix)

Path Parameters

NameTypeRequiredDescription
library_idstring (uuid)yesLibrary ID owned by the authenticated user

Query Parameters

NameTypeRequiredDescription
actionstringyesFixed value: folder_refer
folder_idstring (uuid)yesFolder whose domains you want to list

Response

Success Response (200)

{
  "refers": [
    {
      "id": "789e4567-e89b-12d3-a456-426614174999",
      "url": "course.mysite.com",
      "type": "ALLOW",
      "status": "active",
      "origin": { "type": "folder", "id": "123e4567-e89b-12d3-a456-426614174000" }
    }
  ]
}

Response Schema

FieldTypeDescription
refersobject[]Domains registered on the folder. Empty array when none
refers[].idstring (uuid)Referrer ID — use it to remove or toggle the domain
refers[].urlstringHostname
refers[].typestringALLOW or BLOCK
refers[].statusstringactive, inactive, pending, deleting or turning_inactive
refers[].originobjectScope this row applies to — { type, id }
⚠️

Important

  • Folder domains replace the library list for videos in that folder — they do not add to it.
  • The field is called origin here, but the consolidated view (?action=refer_all) calls the same information scope. This inconsistency is real in the API.

Error Responses

StatusWhen
400Missing or unknown action
404Folder not found
500Internal error

Example Usage

cURL

curl -X GET \
  "https://api-v2.pandavideo.com.br/library/{library_id}?action=folder_refer&folder_id={folder_id}" \
  -H "Authorization: $PANDA_API_TOKEN"

Related

  • Inherited domains: GET /library/{library_id}?action=folder_refer_inherited
  • Add a folder domain: POST /library/{library_id}?action=folder_refer
  • Consolidated view: GET /library/{library_id}?action=refer_all
Path Params
uuid
required

Library ID owned by the authenticated user

Query Params
uuid
required

Folder to inspect

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json