Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
User Detail

Read User Providers

Get an array containing providers associated to the user. If enable_badge_create is set to true, only return providers where the user can create badges.

Use ID 0 to get the current user.

keyword = Filter providers by keyword
enable_badge_create = Only return providers where the user can create badges.
get/v1/user_detail/{user_id}/providers

Path parameters

user_idinteger required

Query parameters

enable_badge_createboolean
keywordstring

Headers

X-Access-Tokenstring nullable

Response

Successful Response

namestring nullable
short_namestring nullable
organisation_namestring nullable
company_numberstring nullable
verification_urlstring nullable
community_idinteger nullable
type'Learning_Provider' | 'Training_Provider' | 'Awarding_Body' | 'Employer' | 'Local_Authority' | 'University' | 'College' | 'Charity' | 'Department' | 'Project' | 'Other'
descriptionstring nullable
emailstring email nullable
phonestring nullable
addressstring nullable
latitudenumber nullable
longitudenumber nullable
citystring nullable
countrystring nullable
external_urlstring nullable
image_urlstring nullable
banner_urlstring nullable
image_url_2xstring nullable
banner_url_2xstring nullable
image_url_originalstring nullable
banner_url_originalstring nullable
source_credly_idinteger nullable
featuredboolean nullable
brand_coloursstring[] nullable
badge_logo_regular_urlstring nullable
badge_logo_mono_urlstring nullable
enable_summary_emailsboolean nullable
enable_surveysboolean nullable
linkedin_organisation_idinteger nullable
social_handle_linkedinstring nullable
social_handle_twitterstring nullable
social_handle_facebookstring nullable
social_handle_instagramstring nullable
consent_supply_of_servicestring date-time nullable
consent_supply_of_service_byinteger nullable
pipedrive_org_idinteger nullable
pipedrive_deal_idinteger nullable
idinteger
status'Active' | 'Suspended' | 'Deleted'
seo_keywordsstring[] nullable
seo_titlestring nullable
seo_descriptionstring nullable
enable_engagement_emailsboolean nullable
rankinginteger nullable
created_by_idinteger nullable
updated_by_idinteger nullable
verified_by_idinteger nullable
verification_request_by_idinteger nullable
time_createdstring date-time
time_updatedstring date-time nullable
time_verifiedstring date-time nullable
time_stats_email_sentstring date-time nullable
{"stackTrail":"components:schemas:Provider:properties:config:anyOf","oasType":"schema","type":"unknown","title":"Config","nullable":true}
is_verifiedboolean nullable
verification_textstring nullable
verification_emailstring email nullable
is_demoboolean nullable
open_accessboolean nullable
enable_analyticsboolean nullable
enable_membersboolean nullable
enable_badge_publishboolean nullable
enable_badge_createboolean nullable
enable_badge_submitboolean nullable
enable_job_feedboolean nullable
qa_community_idinteger nullable
urlstring nullable

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"
  }
]