Provider

Read Provider

Changed on Nov 7, 2026

Get data for a specific provider.

Returns the full Provider schema to platform admins, the provider's own admins, and the parent community's admins. All other callers (including unauthenticated) receive a reduced Provider_Public schema that includes the contact email and the analytics flag but omits phone, address, verification email, internal CRM ids, consent audit trail, every other feature flag, and the arbitrary config dict.

get/v1/provider/{provider_id}

Request

Base URL
https://api.navigatr.app (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Password
Token URL/v1/token
TypeScript
https://skmtc.dev/navigatr/apis/navigatr-api/docs/v1/provider/:provider_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

provider_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

Example response

{
  "name": "Horace's Haberdashery Academy",
  "short_name": "HHA",
  "organisation_name": "Horace's Haberdashery Academy Limited",
  "company_number": "12345678",
  "description": "HHA is the foremost provider of haberdashery education in the UK.",
  "email": "example.email@HHA.org",
  "phone": "0044 113 658 9852",
  "address": "42 Fake Boulevard, Scunthorpe, North Lincolnshire, England, DN1 822",
  "external_url": "https://HHA.org",
  "image_url": "https://media.navigatr.app/HHA.webp",
  "banner_url": "https://media.navigatr.app/HHA_banner.webp",
  "image_url_2x": "https://media.navigatr.app/HHA_2x.webp",
  "banner_url_2x": "https://media.navigatr.app/HHA_banner_2x.webp",
  "image_url_original": "https://media.navigatr.app/HHA_original.webp",
  "banner_url_original": "https://media.navigatr.app/HHA_banner_original.webp",
  "brand_colours": [
    "#FFFF00"
  ],
  "badge_logo_regular_url": "https://media.navigatr.app/HHA_badge.webp",
  "badge_logo_mono_url": "https://media.navigatr.app/HHA_badge_mono.webp",
  "community": {
    "name": "Fordwich Town Council",
    "short_name": "FTC",
    "organisation_name": "Horace's Haberdashery Academy Limited",
    "company_number": "12345678",
    "description": "This is an example of a description of Fordwich Town Council.",
    "email": "example.email@HHA.org",
    "phone": "0044 113 658 9852",
    "address": "23 Not Real Road, Fordwich, Kent, CT4 88R",
    "external_url": "https://Fordwich_Town_Council.org",
    "image_url": "https://media.navigatr.app/Fordwich.webp",
    "banner_url": "https://media.navigatr.app/Fordwich_banner.webp",
    "image_url_2x": "https://media.navigatr.app/Fordwich_2x.webp",
    "banner_url_2x": "https://media.navigatr.app/Fordwich_banner_2x.webp",
    "image_url_original": "https://media.navigatr.app/Fordwich_original.webp",
    "banner_url_original": "https://media.navigatr.app/Fordwich_banner_original.webp",
    "colour": "#844A82",
    "url": "https://navigatr.app/community/5/fordwich-town-council"
  },
  "url": "https://navigatr.app/provider/2922/horaces-haberdashery"
}

Changes

Nov 7, 2026efbd3c328549 Revision changes
- info
  added the optional property /// to the response with the status
- info
  added the optional property / to the response with the status
Oct 22, 20265b575d75af2b Revision changes
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status

Operation history (5 revisions)