Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
User Detail

Read User Communities

Get a list of communities associated to the user. Auth required (Bearer or PAT). Use ID 0 to get the current user.

get/v1/user_detail/{user_id}/communities

Path parameters

user_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

namestring nullable
short_namestring nullable
organisation_namestring nullable
company_numberstring nullable
verification_urlstring nullable
type'City' | 'Region' | 'Local_Authority' | 'Membership_Organisation' | 'Awarding_Body' | 'Partnership' | 'Corporate' | 'Association' | 'University' | 'College' | 'Charity' | 'Other'
descriptionstring nullable
emailstring email nullable
phonestring nullable
addressstring nullable
latitudenumber nullable
longitudenumber nullable
citystring nullable
countrystring nullable
is_defaultboolean 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
featuredboolean nullable
colourstring nullable
enable_summary_emailsboolean 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:Community:properties:config:anyOf","oasType":"schema","type":"unknown","title":"Config","nullable":true}
survey_consentstring nullable
is_demoboolean nullable
is_verifiedboolean nullable
verification_textstring nullable
verification_emailstring email nullable
enable_analyticsboolean nullable
enable_membersboolean nullable
enable_library_cardboolean nullable
spydus_library_urlstring nullable
referral_codestring nullable
urlstring nullable

Example response

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