---
title: /v1/helplines/{helpline_id}
slug: v1helplineshelplineid
docTags: 
createdAt: 2026-05-06T23:35:31.392Z
---

{
  "id": "6LQZNBhAqARK7zROtn7Qo",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.throughlinecare.com/v1/helplines/{helpline_id}",
    "description": "Returns a single helpline for the given unique identifier.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "helpline_id",
          "type": "string",
          "description": "Unique identifier of the helpline to get."
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "bearerAuth",
          "name": "Authorization",
          "kind": "optional",
          "type": "apiKey",
          "description": "<p>Enter the token with the \"Bearer: \" prefix e.g. \"Bearer ABC...\"</p>",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Returns the helpline matching the unique identifier.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Returns the helpline matching the unique identifier.",
            "schema": [
              {
                "name": "helpline",
                "kind": "optional",
                "type": "object",
                "description": "HelplineV1 model",
                "modelRef": "#/definitions/HelplineV1",
                "customType": "HelplineV1",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string",
                    "description": "The unique identifier for the helpline.",
                    "example": "crisis-text-line"
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "description": "Official name of the helpline in the native language.",
                    "example": "Crisis Text Line"
                  },
                  {
                    "name": "description",
                    "kind": "optional",
                    "type": "string",
                    "description": "Description of the service provided by the helpline in English.",
                    "example": "Crisis Text Line is here to help you, whatever you're going through. We provide 24/7, free and confidential support and information by text message (text HOME to 741-741), online chat and WhatsApp (+1-443-787-7678). We are available to talk with you about any kind of experience relating to mental health, including anxiety, depression, self-harm, stress, and thoughts of suicide."
                  },
                  {
                    "name": "shortDescription",
                    "kind": "optional",
                    "type": "string",
                    "description": "A concise summary of the service provided by the helpline in English.",
                    "example": "24/7 free crisis support for youth in NZ"
                  },
                  {
                    "name": "website",
                    "kind": "optional",
                    "type": "string<uri>",
                    "description": "Primary website of the service.",
                    "example": "https://www.crisistextline.org/",
                    "format": "uri"
                  },
                  {
                    "name": "country",
                    "kind": "required",
                    "type": "object",
                    "description": "",
                    "complexType": "allOf",
                    "complexItems": [
                      {
                        "name": "Country",
                        "description": "",
                        "modelRef": "#/definitions/Country",
                        "schema": [
                          {
                            "name": "name",
                            "kind": "required",
                            "type": "string",
                            "description": "English language name for the country.",
                            "example": "New Zealand"
                          },
                          {
                            "name": "code",
                            "kind": "required",
                            "type": "string",
                            "description": "<p>ISO 3166 Alpha-2 code for the country.</p>",
                            "example": "nz"
                          },
                          {
                            "name": "emergencyNumber",
                            "kind": "optional",
                            "type": "string",
                            "description": "Emergency services phone number. Only available for countries where suicide is not a illegal.",
                            "example": "111"
                          }
                        ]
                      }
                    ],
                    "schema": []
                  },
                  {
                    "name": "timezone",
                    "kind": "required",
                    "type": "string",
                    "description": "The timezone where this helpline operates.",
                    "example": "America/Los_Angeles"
                  },
                  {
                    "name": "topics",
                    "kind": "required",
                    "type": "array",
                    "description": "A collection of topics which the helpline supports.",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "supported_languages",
                    "kind": "required",
                    "type": "array",
                    "description": "A collection of ISO language codes that the helpline supports.",
                    "example": "[\"en\",\"es\",\"fr\"]",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "specialties",
                    "kind": "required",
                    "type": "array",
                    "description": "<p>Specialties categorize services by audience demographics, identity groups, and specific service needs.</p>",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "supportTypes",
                    "kind": "optional",
                    "type": "array",
                    "description": "<p>A collection listing the qualification of the people who provide support at the helpline. e.g. Counselors, Volunteers, Peers, etc. Only available for Full tier applications</p>",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "hours",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "complexType": "allOf",
                    "complexItems": [
                      {
                        "name": "Hours",
                        "description": "",
                        "modelRef": "#/definitions/Hours",
                        "schema": [
                          {
                            "name": "alwaysOpen",
                            "kind": "required",
                            "type": "boolean",
                            "description": "<p>Indicates if the helpline is always open. If true, the periods field will be empty. If false, the periods field will contain the opening hours for the helpline.</p>"
                          },
                          {
                            "name": "periods",
                            "kind": "required",
                            "type": "array",
                            "description": "<p>A collection of periods representing the opening hours for the helpline. Only available if always_open is false.</p>",
                            "modelRef": "#/definitions/Period",
                            "customType": "Period[]",
                            "schema": [
                              {
                                "name": "day",
                                "kind": "required",
                                "type": "integer<int32>",
                                "description": "<p>An integer representation of the day of the week that the period applies to. Days are index from 1, with Monday=1, Tuesday=2, through to Sunday=7.</p>",
                                "example": "1",
                                "format": "int32"
                              },
                              {
                                "name": "open",
                                "kind": "required",
                                "type": "string<time>",
                                "description": "The time the helpline opens on the given day.",
                                "example": "09:00",
                                "format": "time"
                              },
                              {
                                "name": "close",
                                "kind": "required",
                                "type": "string<time>",
                                "description": "The time the helpline closes on the given day.",
                                "example": "17:00",
                                "format": "time"
                              }
                            ]
                          }
                        ]
                      }
                    ],
                    "schema": []
                  },
                  {
                    "name": "phoneNumber",
                    "kind": "optional",
                    "type": "string",
                    "description": "Phone number that people in crisis can call.",
                    "example": "1-800-555-1212"
                  },
                  {
                    "name": "smsNumber",
                    "kind": "optional",
                    "type": "string",
                    "description": "SMS number that people in crisis can txt.",
                    "example": "741741"
                  },
                  {
                    "name": "webChatUrl",
                    "kind": "optional",
                    "type": "string<uri>",
                    "description": "URL that people in crisis can use to start an online chat.",
                    "example": "https://connect.crisistextline.org/chat?utm_source=findahelpline",
                    "format": "uri"
                  },
                  {
                    "name": "whatsappUrl",
                    "kind": "optional",
                    "type": "string<uri>",
                    "description": "WhatsApp URL that people in crisis can use to start a WhatsApp chat.",
                    "example": "https://wa.me/1-800-555-1212",
                    "format": "uri"
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Unique identifier is missing",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "403",
        "description": "The helpline does support any of the permitted countries or topics for the application.",
        "jsonExample": "",
        "isExpanded": true
      },
      {
        "statusCode": "404",
        "description": "Helpline not found",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "mMWqNHS4JpyrM8jCUB90M",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.throughlinecare.com/v1/helplines/{helpline_id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "ZZo03hJdEenBgZIWs5kcQ",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.throughlinecare.com/v1/helplines/{helpline_id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "KQxnZcNqhXchKfh-bpHno",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.throughlinecare.com/v1/helplines/{helpline_id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        },
        {
          "id": "9rnBMzehXzJTD6O4g7LQC",
          "language": "java",
          "label": "Java",
          "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n   .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n   .url(\"https://api.throughlinecare.com/v1/helplines/{helpline_id}\")\n   .method(\"GET\", body)\n   .addHeader(\"accept\", \"application/json\")\n   .addHeader(\"content-type\", \"application/json\")\n   .build();\nResponse response = client.newCall(request).execute();"
        },
        {
          "id": "JuiofQEnf6uAemIiY4TLT",
          "language": "swift",
          "label": "Swift",
          "code": "var request = URLRequest(url: URL(string: \"https://api.throughlinecare.com/v1/helplines/{helpline_id}\")!,timeoutInterval: Double.infinity)\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"accept\")\nrequest.addValue(\"application/json\", forHTTPHeaderField: \"content-type\")\n\nrequest.httpMethod = \"GET\"\n\nlet task = URLSession.shared.dataTask(with: request) { data, response, error in \n   guard let data = data else {\n      print(String(describing: error))\n      return\n   }\n   print(String(data: data, encoding: .utf8)!)\n}\n\ntask.resume()\n"
        }
      ],
      "selectedLanguageId": "mMWqNHS4JpyrM8jCUB90M"
    },
    "results": {
      "languages": [
        {
          "id": "XcTDioy6v3sMofR51EQ3U",
          "language": "200",
          "code": "// Returns the helpline matching the unique identifier.\n{\n  \"helpline\": {\n    \"id\": \"crisis-text-line\",\n    \"name\": \"Crisis Text Line\",\n    \"description\": \"Crisis Text Line is here to help you, whatever you're going through. We provide 24/7, free and confidential support and information by text message (text HOME to 741-741), online chat and WhatsApp (+1-443-787-7678). We are available to talk with you about any kind of experience relating to mental health, including anxiety, depression, self-harm, stress, and thoughts of suicide.\",\n    \"shortDescription\": \"24/7 free crisis support for youth in NZ\",\n    \"website\": \"https://www.crisistextline.org/\",\n    \"country\": {},\n    \"timezone\": \"America/Los_Angeles\",\n    \"topics\": [\n      \"\"\n    ],\n    \"supported_languages\": [\n      \"\"\n    ],\n    \"specialties\": [\n      \"\"\n    ],\n    \"supportTypes\": [\n      \"\"\n    ],\n    \"hours\": {},\n    \"phoneNumber\": \"1-800-555-1212\",\n    \"smsNumber\": \"741741\",\n    \"webChatUrl\": \"https://connect.crisistextline.org/chat?utm_source=findahelpline\",\n    \"whatsappUrl\": \"https://wa.me/1-800-555-1212\"\n  }\n}"
        },
        {
          "id": "iz0NyERE8gS6ZIeL69edD",
          "language": "400",
          "code": "// Unique identifier is missing\n"
        },
        {
          "id": "avRVl15Vkyyb91zlpC8mr",
          "language": "403",
          "code": "// The helpline does support any of the permitted countries or topics for the application.\n"
        },
        {
          "id": "KsxDkdtFJfDcUjU4k0bml",
          "language": "404",
          "code": "// Helpline not found\n"
        }
      ],
      "selectedLanguageId": "XcTDioy6v3sMofR51EQ3U"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}