Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-242310.2 KB
Helplines

Get helplines for a specific country

Returns an array of crisis helplines for the specified country. The country parameter accepts both full country names and aliases (e.g., "USA", "America" for "United States").

Response Patterns

  • Returns empty array [] if country has no helplines or is unknown
  • Returns 400 error if country parameter is missing
  • Returns 403 error if request origin is not allowed (CORS)
get/crisis_helplines

Query parameters

countrystring required

Country name or alias to retrieve helplines for.

Examples:

  • United States
  • USA (alias for United States)
  • America (alias for United States)
  • Canada
  • CAN (alias for Canada)

Country names are case-sensitive and should match exactly as stored in the database.

Response

Successfully retrieved helplines for the specified country

countrystring required

Full country name where this helpline operates

countryI18nKeystring required

Internationalization key for the country (typically locale code)

countryCodestring required

ISO 3166-1 alpha-2 country code

namestring required

Name of the helpline organization or service

descriptionstring required

Brief description of the services provided

urlstring uri required

Full URL to the helpline's website

displayURLstring

Human-friendly display version of the URL (without protocol)

phonestring required

Raw phone number or short code

displayNumberstring required

Phone number formatted for display purposes

formattedCallNumberstring required

Phone number formatted for tel: links (calling)

formattedTextingNumberstring required

Phone number formatted for sms: links (texting)

displayTextNumberstring

Text message number formatted for display

availabilitystring required

Human-readable availability description

Common values:

  • 24/7 - Available around the clock
  • Business hours - Standard business hours only
  • Custom schedules (e.g., "Mon-Fri 9am-5pm")
modality'phone' | 'text' | 'chat' | 'email' required

Primary contact method for this helpline

Common values:

  • phone - Voice call support
  • text - SMS/text message support
  • chat - Online chat support
  • email - Email support
identitystring required

Target demographic or identity group for this helpline

Examples:

  • general - Available to everyone
  • youth - Specifically for young people
  • lgbtq - LGBTQ+ focused
  • veterans - Military veterans
  • indigenous - Indigenous/native populations
topicstring required

Primary topic or issue area addressed by this helpline

Examples:

  • crisis - General crisis support
  • suicide - Suicide prevention
  • domestic_violence - Domestic violence support
  • substance_abuse - Addiction and substance abuse
  • mental_health - Mental health support
topicMenuboolean required

Whether this helpline should appear in topic-based filtering menus

Used for UI/UX to determine which helplines to show in categorized views.

hoursstring

Detailed hours of operation (may duplicate availability field)

Example response

[
  {
    "country": "United States",
    "countryI18nKey": "en-US",
    "countryCode": "US",
    "name": "Crisis Text Line",
    "description": "24/7 crisis support via text message",
    "url": "https://crisistextline.org",
    "displayURL": "crisistextline.org",
    "phone": "741741",
    "displayNumber": "741741",
    "formattedCallNumber": "741741",
    "formattedTextingNumber": "741741",
    "availability": "24/7",
    "modality": "text",
    "identity": "general",
    "topic": "crisis",
    "topicMenu": true,
    "hours": "24/7"
  }
]