{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3ab8ff47-c49f-4714-bde6-b5d75203912f","name":"Metadata Bank API Version 1.3.12 - Rest API","description":"## The Metadata Bank is a centralized hub for all high-value show metadata, ensuring data consistency and accuracy across all platforms. It not only stores critical show details but also offers a suite of APIs for efficient data management. This makes it an essential tool for PBS's media organizations and supply chain, streamlining content management workflows and enhancing audience viewing experience.\n\n### To request an API Access Token, please visit [API Key request](https://software.pbs.org/support/solutions/articles/9000162335-requesting-access).\n\n#### For all other inquiries, please direct them to our [Support Portal](https://support.pbs.org).\n\n## Versioning\n\n| Type | Frequency | notes |\n| --- | --- | --- |\n| Major | Twice yearly | Focus on 'disruptive' changes |\n| Dot Version | Quarterly | Focus on non-disruptive changes |\n\nTo indicate the version of an endpoint to use in the request, add a suffixed path to the API, such as `.../rest/v1/`.\n\nSet your `{{baseurl}}` value e.g., `https://api.metadata.services.pbs.org/rest/v1/`\n\nIf you have client access key, secret key and scope , get your session token `{{application-scope}}` value e.g.,[<code>https://gw.metadata.services.pbs.org/oauth2/token?grant_type=client_credentials&amp;scope={{application-scope}}</code>](https://gw.metadata.services.pbs.org/oauth2/token?grant_type=client_credentials&scope=)\n\nWe don't maintain 'Backwards Compatibility' after launching a major version during our twice-a-year planned updates. But, if a serious defect requires a major version update, we'll support the previous version until the next major version is scheduled for release.\n\n## Release Notes\n\nFind the API Release Notes at [software.pbs.org](https://software.pbs.org).\n\n## Environments: REST oAUTH URL\n\n| Environment | REST oAUTH Url | notes |\n| --- | --- | --- |\n| QA | https://`gwqa`.metadata.services.pbs.org/oauth2/token?`grant_type=client_credentials&scope=<>` | Latest versions released here first, data refreshed quarterly |\n| TEST | https://`staging`.metadata.services.pbs.org/oauth2/token?`grant_type=client_credentials&scope=<>` | data in sync with production , read only environment |\n| Production | https://`gw`.metadata.services.pbs.org/oauth2/token?`grant_type=client_credentials&scope=<>` |  |\n\n## Environments: REST\n\n| Environment | REST API Base Url | notes |\n| --- | --- | --- |\n| QA | https://`qa`.metadata.services.pbs.org/`rest/v1` | Latest versions released here first, data refreshed quarterly |\n| TEST | https://`staging`.metadata.services.pbs.org/`rest/v1` | data in sync with production , read only environment |\n| Production | https://`api`.metadata.services.pbs.org/`rest/v1` |  |\n\n**Notes:**\n\n- Each environment will have separate API token\n    \n- Data created or modified in each environment will not affect the other.\n    \n- Data cannot be transferred from one environment to the other.\n    \n\n## Documentation Conventions\n\nThis document adheres to the following standards:\n\n- For all strings, the pattern `^(.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*)$` is consistently employed.\n    \n- All communications are conducted via the `HTTP protocol`.\n    \n- Responses are presented in the `JSON format`.\n    \n- `Request parameters` are optional unless explicitly marked as mandatory by a red asterisk.\n    \n- `Country codes` (CountryOfOrigin) align with the ISO Country Code, which is accessible here: [https://www.iso.org/obp/ui/#search](https://www.iso.org/obp/ui/#search)\n    \n- `Language codes` (TitleLanguage, PrimaryLanguage, and SecondaryLanguage) correspond to the ISO 639-1 Code, accessible here: [http://www.loc.gov/standards/iso639-2/php/code_list.php](http://www.loc.gov/standards/iso639-2/php/code_list.php)\n    \n\n## Schema\n\n- Data exchange format: `JSON`\n    \n- Timestamp format: `ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)`\n    \n- Detailed Representations:  \n    Fetching individual resources includes all attributes  \n    Includes children from the next downstream data entity, known as the \"detailed\" representation of the resource\n    \n\n## Rate Limits\n\nAPI access rate limits depend on the specific endpoint being used. Unless clearly stated in the endpoint documentation, the typical rate limit is set to`800 requests per minute for all entities.`\n\n## Hypermedia Links\n\nAll GET methods return entities that contain hypermedia links, which also include sub-resource collections.\n\nSee below example of GET Episode with Hypermedia links.\n\n``` json\n{\n    \"_links\": {\n        \"self\": {\n            \"href\": \"/episode/cid:org:pbs.org:Episode839\"\n        },\n        \"organizations\": {\n            \"href\": \"/episode/cid:org:pbs.org:Episode839/organizations\"\n        },\n        \"credits\": {\n            \"href\": \"/episode/cid:org:pbs.org:Episode839/credits\"\n        },\n        \"season\": {\n            \"href\": \"/season/cid:org:pbs.org:Season54\"\n        }\n    },\n    ...\n}\n\n ```\n\n## Pagination\n\nAll GET requests, encompassing every search function, deliver results in a paginated format.\n\n- The default 'pagesize' is 10, with the exception of the EVENT method where it's 50.\n    \n- As an illustration, the first batch of results will display entries 0-19, followed by a navigational link.\n    \n- The 'next-batch' property hosts the link that leads to the succeeding 10 results.\n    \n\n``` json\n{ \n  \"links\": { \n   \"next_batch\": \n        \"{{baseURL}}/season/{{seasonUID}}/?pagesize=5&offset=5\" \n       } \n}\n\n ```\n\n## OAuth API Key Usage\n\nAn OAuth2 API key is necessary for transferring payloads into the system. Please be aware that your OAuth API key can be revoked by the Administrator at any time.\n\nTo obtain OAuth2 API keys, [apply online](http://software.pbs.org/support/solutions/articles/9000162335-requesting-access) .\n\nThe OAuth API key issued is specific to your platform.\n\nConsider your `API Token` as you would a password:\n\n- Ensure its secure storage.\n    \n- Do not share it with individuals outside of your organization.\n    \n- Avoid embedding it in any code on your website or in a URL that might be accessible to others.\n    \n- Although `notifications` have a `PublicKey` dedicated to your platform, it is still advised not to share this access token.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6023363","team":147252,"collectionId":"3ab8ff47-c49f-4714-bde6-b5d75203912f","publishedId":"2sBXqDrN6v","public":true,"publicUrl":"https://metadata-bank.pbs.org","privateUrl":"https://go.postman.co/documentation/6023363-3ab8ff47-c49f-4714-bde6-b5d75203912f","customColor":{"top-bar":"48D3CD","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Streamline PBS and PBS station's data management with the Metadata Bank. Ensure accuracy across platforms with our centralized hub and APIs, enhancing workflows and viewer experience."},{"name":"title","value":"Enhancing PBS Workflow: The Metadata Bank's Role in Streamlining Data for PBS and Member Stations"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"48D3CD","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-04-16T22:04:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Enhancing PBS Workflow: The Metadata Bank's Role in Streamlining Data for PBS and Member Stations","description":"Streamline PBS and PBS station's data management with the Metadata Bank. Ensure accuracy across platforms with our centralized hub and APIs, enhancing workflows and viewer experience."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8973f11e29b3e3f861659c19fa5495bfc0b71097666fdb970f1241d18087af39","favicon":"https://res.cloudinary.com/postman/image/upload/v1572968227/team/rdzsty7tipet7iditfw7.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://metadata-bank.pbs.org/view/metadata/2sBXqDrN6v"}