Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
Community

Read Community Providers

Get an array of providers in a community.

Returns the full Provider schema (PII, CRM ids, verification email, phone, feature flags) to platform admins and community admins of the queried community. Every other caller — authenticated non-admin or unauthenticated — receives the reduced Provider_Public schema. The public community page ("Providers" tab on /community/<id>/<label>) depends on the anonymous read path; this is the schema that path returns.

Precursor P-Nav-WAKSA-202605-013 (re-test of P-Nav-WAKA-202503-013 / #1282): the previous fix covered /community/ and /provider/stats/community/{id} but missed this sibling. The pattern is identical.

get/v1/community/{community_id}/providers

Path parameters

community_idinteger required

Query parameters

order_by'Time_Created_Asc' | 'Time_Created_Desc' | 'Name_Asc' | 'Name_Desc'
keywordstring
statusstring
type'Learning_Provider' | 'Training_Provider' | 'Awarding_Body' | 'Employer' | 'Local_Authority' | 'University' | 'College' | 'Charity' | 'Department' | 'Project' | 'Other'
featuredboolean
paginatedboolean
pageinteger
sizeinteger

Headers

X-Access-Tokenstring nullable

Response

Successful Response

OR
OR
OR

Example response

{
  "items": [
    {
      "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"
    }
  ]
}