--- id: get-pin sidebar_label: Get a Pin hide_title: true hide_table_of_contents: true api: {"tags":["Plex.tv"],"operationId":"getPin","description":"Retrieve a Pin from Plex.tv for authentication flows","security":[{"ClientIdentifier":[]}],"parameters":[{"name":"strong","description":"Determines the kind of code returned by the API call\nStrong codes are used for Pin authentication flows\nNon-Strong codes are used for `Plex.tv/link`\n","in":"query","schema":{"type":"boolean","default":false},"required":false}],"responses":{"200":{"description":"The Pin","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"PinID for use with authentication","type":"number","example":1272322473},"code":{"type":"string","example":"3patfx1a78ukcbr7x0n9bl26t"},"product":{"type":"string","example":"Plex Web"},"trusted":{"type":"boolean"},"qr":{"description":"a link to a QR code hosted on plex.tv \nThe QR code redirects to the relevant `plex.tv/link` authentication page\nWhich then prompts the user for the 4 Digit Link Pin\n","type":"string","example":"https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t"},"clientIdentifier":{"type":"string","example":"Postman"},"location":{"type":"object","properties":{"code":{"type":"string","example":"US"},"european_union_member":{"type":"boolean"},"continent_code":{"type":"string","example":"NA"},"country":{"type":"string","example":"United States"},"city":{"type":"string","example":"Austin"},"time_zone":{"type":"string","example":"America/Chicago"},"postal_code":{"type":"string","example":78732},"in_privacy_restricted_country":{"type":"boolean"},"subdivisions":{"type":"string","example":"Texas"},"coordinates":{"type":"string","example":"30.3768 -97.8935"}}},"expiresIn":{"type":"number","example":1800},"createdAt":{"type":"string","format":"date-time","example":"2023-04-12T17:00:03.000Z"},"expiresAt":{"type":"string","format":"date-time","example":"2023-04-12T17:30:03.000Z"},"authToken":{"type":"string","format":"nullable"},"newRegistration":{"type":"string","format":"nullable"}}}}}},"400":{"description":"X-Plex-Client-Identifier is missing","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1000},"message":{"type":"string","example":"X-Plex-Client-Identifier is missing"},"status":{"type":"number","example":400}}}}}}}}}},"method":"post","path":"/pins","servers":[{"url":"https://plex.tv/api/v2"}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex.TV API Map","description":"An Open API Spec for interacting with Plex.tv","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Get a Pin","description":{"content":"Retrieve a Pin from Plex.tv for authentication flows","type":"text/plain"},"url":{"path":["pins"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines the kind of code returned by the API call\nStrong codes are used for Pin authentication flows\nNon-Strong codes are used for `Plex.tv/link`\n","type":"text/plain"},"key":"strong","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST","auth":{"type":"apikey","apikey":[{"type":"any","value":"X-Plex-Client-Identifier","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: docs/plex-tv/plex-api --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem";

Get a Pin

Retrieve a Pin from Plex.tv for authentication flows
Query Parameters
The Pin
Schema
    location object
X-Plex-Client-Identifier is missing
Schema
    errors object[]
  • Array [
  • ]