> ## Documentation Index > Fetch the complete documentation index at: https://docs.phosra.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a platform > Get platform details ## OpenAPI ````yaml GET /platforms/{platformID} openapi: 3.1.0 info: title: Phosra API description: Universal Parental Controls API - Define once, push everywhere version: 1.0.0 contact: name: Phosra Developer Support url: https://docs.phosra.com license: name: Proprietary url: https://phosra.com/terms servers: - url: https://phosra-api-sandbox-production.up.railway.app/api/v1 description: >- Hosted sandbox — the one canonical, stable, partner-facing testing endpoint (seeded demo family + phosra_test_ keys). Default so the inline Try it never touches production. Same base the CLI uses. - url: https://prodapi.phosra.com/api/v1 description: Production - url: http://localhost:8080/api/v1 description: Local development security: - BearerAuth: [] paths: /platforms/{platformID}: parameters: - name: platformID in: path required: true schema: type: string get: tags: - Platforms summary: Get platform details description: >- Returns the catalog entry for a single platform, including its category, enforcement capabilities, and OAuth support. operationId: getPlatformDetails responses: '200': description: Platform details content: application/json: schema: $ref: '#/components/schemas/Platform' example: id: nextdns name: NextDNS category: dns tier: compliant description: >- DNS-level content filtering and SafeSearch enforcement for family networks. icon_url: https://cdn.phosra.com/platforms/nextdns.svg auth_type: api_key enabled: true enforcement_mode: dns rule_support: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': description: Platform not found '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' '502': $ref: '#/components/responses/BadGateway' '503': $ref: '#/components/responses/ServiceUnavailable' security: [] x-codeSamples: - lang: JavaScript label: SDK (@phosra/sdk) source: | import { PhosraClient } from "@phosra/sdk"; const phosra = new PhosraClient({ baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1", accessToken: process.env.PHOSRA_API_KEY, }); const result = await phosra.platforms.get("fire_tablet"); console.log(result); - lang: Shell label: cURL source: > curl -sS "https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/fire_tablet" - lang: Python label: Python source: | import requests BASE = "https://phosra-api-sandbox-production.up.railway.app/api/v1" res = requests.get( f"{BASE}/platforms/fire_tablet", ) print(res.status_code, res.json()) - lang: Go label: Go source: "package main\n\nimport (\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n)\n\nfunc main() {\n\tbase := \"https://phosra-api-sandbox-production.up.railway.app/api/v1\"\n\treq, _ := http.NewRequest(\"GET\", base+\"/platforms/fire_tablet\", nil)\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n\tout, _ := io.ReadAll(resp.Body)\n\tfmt.Println(resp.Status, string(out))\n}\n" components: schemas: Platform: type: object properties: id: type: string description: Unique identifier for this resource. name: type: string description: Human-readable display name. category: type: string enum: - dns - streaming - gaming - device - browser description: >- OCSS rule category this rule enforces (see the Rule Categories reference). tier: type: string enum: - compliant - provisional - pending description: Accreditation / integration tier of the platform. description: type: string description: Human-readable description. icon_url: type: string description: URL of the platform or resource icon. auth_type: type: string enum: - api_key - oauth2 - manual description: How the platform is authenticated (e.g. `oauth`, `manual`). enabled: type: boolean description: Whether this item is currently active. enforcement_mode: type: string enum: - dns - device - api_write - manual_attested - coming_soon description: > How Phosra enforces rules on this platform. `dns` = live DNS-provider API write (NextDNS/CleanBrowsing/Control D); `device` = on-device enforcement, requires Phosra app installed; `api_write` = live third-party write API; `manual_attested` = no programmatic API — Phosra generates setup steps and records a signed parent attestation. Never render "Enforced" for this value; `coming_soon` = adapter not yet built. rule_support: type: object additionalProperties: type: string enum: - dns - device - guided - unsupported description: > Per-category enforcement support across all 123 OCSS rule categories. `dns` = DNS provider can filter this category; `device` = on-device enforcement handles it; `guided` = manual_attested platform, parent applies with Phosra guidance; `unsupported` = not addressable on this platform. additionalProperties: true Error: type: object properties: error: type: string description: >- Short, stable, machine-readable error class — matches the HTTP status text (e.g. `Not Found`). message: type: string description: >- Human-readable explanation of what went wrong and, where possible, how to fix it. code: type: integer description: Numeric HTTP status code, duplicated in the body for convenience. description: Standard error envelope returned for every 4xx and 5xx response. example: error: Not Found message: policy not found code: 404 additionalProperties: true responses: BadRequest: description: >- The request was malformed — a required field is missing, a value failed validation, or an identifier is not a well-formed UUID. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Bad Request message: child_name is required code: 400 Unauthorized: description: >- Authentication failed. Send a Bearer WorkOS JWT, or a `phosra_live_`/`phosra_test_` developer API key, in the `Authorization` header. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized message: missing or invalid Authorization header code: 401 RateLimited: description: >- Too many requests. Back off and retry after the interval given in the `Retry-After` response header. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Too Many Requests message: rate limit exceeded code: 429 ServerError: description: >- An unexpected error occurred inside Phosra. The request is safe to retry with exponential backoff; contact support if it persists. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Internal Server Error message: internal error code: 500 BadGateway: description: >- A downstream provider returned an invalid response while Phosra was fulfilling the request. Retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Bad Gateway message: downstream provider error code: 502 ServiceUnavailable: description: >- A downstream provider or dependency is temporarily unavailable. Retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Service Unavailable message: downstream provider unavailable code: 503 securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````