API
Core Concepts
Priority Helpline Filtering
3 min
topics currently available suicidal thoughts the helpline endpoint supports two distinct retrieval modes standard (comprehensive) and priority (curated) these modes control the selection and ranking logic of the results, but always return the same data structure, ensuring simple integration the choice of mode is controlled by the optional boolean query parameter priority only mode parameter flag selection logic best for standard (default no flag needed) returns all verified helplines matching the country and topic, ranked by our algorithm broad discovery, filtering, and navigable user interfaces priority priority only=true returns a curated short list of the country's most critical helplines for the topic "show one number" uis and quick, universal referral technical integration this design ensures backward compatibility by maintaining the exact same data structure and json shape for results in both modes how to request priority helplines to access the curated priority mode list, simply add the priority only flag to your request `https //api throughlinecare com/v1/helplines?country code=us\&topic=suicidal%20thoughts\&priority only=true existing integrations will continue to default to standard mode (unfiltered) and require no code changes to function criteria for priority helplines the services returned when priority only=true represent the country's foremost resource(s) for the topic these services are specifically selected to be the default, universally recommended option for all individuals seeking support with that topic universal reach & paired services the service(s) must be capable of supporting all individuals who make contact, regardless of age or demographic crucial rule if the query returns a list containing two services (e g , one for adults, one for youth, or services for two official languages), api consumers must display both services or refrain from displaying any displaying only one of a pair would risk recommending a specialized service to an unsuitable demographic filtering exception if you can reliably detect demographic data (such as age or preferred language) prior to calling the api, you may use that data in combination with specialty filters (e g , specialty=children ) to potentially return only the single most appropriate service from the curated list primary mission the service's main purpose must be to support individuals with the topic, and it must be recognized within the country as the foremost resource for this issue nationwide scope available and accessible throughout the entire country extensive hours operates with extensive hours to ensure broad availability and high service reliability