Enter the token with the \"Bearer: \" prefix e.g. \"Bearer ABC...\"
", "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": "Helpline model", "modelRef": "#/definitions/Helpline", "customType": "Helpline", "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": "descriptions", "kind": "optional", "type": "array", "description": "Descriptions of the service provided by the helpline, one entry per language. Empty for Entry-tier applications.
", "modelRef": "#/definitions/Description", "customType": "Description[]", "schema": [ { "name": "language", "kind": "required", "type": "string", "description": "ISO language code of this description.", "example": "en" }, { "name": "fullDescription", "kind": "required", "type": "string", "description": "Full description of the service provided by the helpline. Formatting, if any, will use markdown.
" }, { "name": "shortDescription", "kind": "optional", "type": "string", "description": "Concise summary of the service provided by the helpline. Currently only available for English." } ] }, { "name": "website", "kind": "optional", "type": "stringISO 3166 Alpha-2 code for the country.
", "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": "primaryTopics", "kind": "required", "type": "array", "description": "A collection of topics which the helpline primarily supports.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "secondaryTopics", "kind": "required", "type": "array", "description": "A collection of topics which the helpline secondarily supports.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "supportedLanguages", "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": "Specialties categorize services by audience demographics, identity groups, and specific service needs.
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "supportTypes", "kind": "optional", "type": "array", "description": "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
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "interpretationServiceProvided", "kind": "required", "type": "boolean", "description": "Whether the helpline provides interpretation services for people who do not speak any of the supported languages." }, { "name": "membershipOrganizations", "kind": "required", "type": "array", "description": "A collection of membership organizations that the helpline is affiliated with.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "contactMethods", "kind": "required", "type": "array", "description": "Ways to reach this helpline. Each element carries its own opening hours.", "modelRef": "#/definitions/ContactMethod", "customType": "ContactMethod[]", "schema": [ { "name": "type", "kind": "required", "type": "stringThe value used to reach the helpline by this contact method (e.g. phone number or chat URL).
", "example": "1-800-273-8255" }, { "name": "accessibilityNotes", "kind": "optional", "type": "string", "description": "Optional notes about the accessibility of this contact method." }, { "name": "alwaysOpen", "kind": "required", "type": "boolean", "description": "Indicates if this contact method is always available. When true, openingHours will be empty.
Opening periods for this contact method with overlapping and adjacent periods merged and resolved to the helpline's timezone. Empty when alwaysOpen is true. null when the application's API tier does not permit access to opening hours.
ISO 8601 datetime of the next occurrence of when the helpline opens, in the helpline's timezone.
", "example": "2026-04-13T09:00:00+12:00", "format": "date-time" }, { "name": "close", "kind": "required", "type": "stringISO 8601 datetime of the next occurrence of when the helpline closes, in the helpline's timezone.
", "example": "2026-04-13T17:00:00+12:00", "format": "date-time" } ] } ] } ] } ], "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": "w6kum_59e3MpClnEzkz7L", "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/v2/helplines/{helplineId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "6tSqqwV27fhiaq6j1sVUq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.throughlinecare.com/v2/helplines/{helplineId}\")\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": "XgZnqaQwv2fyIx7ceiWLo", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.throughlinecare.com/v2/helplines/{helplineId}\"\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": "qNFfmkZx1B-n0So3ihnus", "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/v2/helplines/{helplineId}\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" }, { "id": "S3bEMgj3CHatyA4WXWPTs", "language": "swift", "label": "Swift", "code": "var request = URLRequest(url: URL(string: \"https://api.throughlinecare.com/v2/helplines/{helplineId}\")!,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": "w6kum_59e3MpClnEzkz7L" }, "results": { "languages": [ { "id": "Tk9iUqFjHDNWFRN7L172i", "language": "200", "code": "// Returns the helpline matching the unique identifier.\n{\n \"helpline\": {\n \"id\": \"crisis-text-line\",\n \"name\": \"Crisis Text Line\",\n \"descriptions\": [\n {\n \"language\": \"en\",\n \"fullDescription\": \"\",\n \"shortDescription\": \"\"\n }\n ],\n \"website\": \"https://www.crisistextline.org/\",\n \"country\": {},\n \"timezone\": \"America/Los_Angeles\",\n \"primaryTopics\": [\n \"\"\n ],\n \"secondaryTopics\": [\n \"\"\n ],\n \"supportedLanguages\": [\n \"\"\n ],\n \"specialties\": [\n \"\"\n ],\n \"supportTypes\": [\n \"\"\n ],\n \"interpretationServiceProvided\": false,\n \"membershipOrganizations\": [\n \"\"\n ],\n \"contactMethods\": [\n {\n \"type\": \"phone\",\n \"value\": \"1-800-273-8255\",\n \"accessibilityNotes\": \"\",\n \"alwaysOpen\": false,\n \"openingHours\": [\n {\n \"localDayOfWeek\": \"monday\",\n \"open\": \"2026-04-13T09:00:00+12:00\",\n \"close\": \"2026-04-13T17:00:00+12:00\"\n }\n ]\n }\n ]\n }\n}" }, { "id": "VCLBmciJo4EjjnpgzCLyw", "language": "400", "code": "// Unique identifier is missing\n" }, { "id": "vN8zJV3jqcjbKhEN_NAm-", "language": "403", "code": "// The helpline does support any of the permitted countries or topics for the application.\n" }, { "id": "-IOECRxP7PC9CZ8xr5gl-", "language": "404", "code": "// Helpline not found\n" } ], "selectedLanguageId": "Tk9iUqFjHDNWFRN7L172i" } }, "children": [ { "text": "" } ] }