Welcome to NameShouts 2.0 Developer Documentation. The NameShouts API 2.0 lets your applications fetch data from the NameShouts database, access our audio files and access custom lists (with verified and recorded pronunciations).
\nWe also support cross-origin resource sharing. This allows you to interact securely with the API from a client-side web application.
\nBased on simple REST principles, our Web API endpoints return metadata in JSON format.
\nThese API references are newly launched. We've put lots of effort into improving content and completeness to support this launch, but you might find areas that need more love. Please consider reaching out to us at contact@nameshouts.com if you have any feedback.
\nBase Address of the API:
\nhttps://api.nameshouts.com/api/v2.0/Rate Limits:
\nThe rate limits for name searches are 60 requests/minute and for higher tier requests it may be limited to 20 requests/minute. These limits may be increased if requested.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1200138","collectionId":"cf852e31-0b0f-4419-a01d-b703c1ed56df","publishedId":"VUjPJ5xc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-09-11T07:39:36.000Z"},"item":[{"name":"Authenticating Requests","item":[{"name":"Get language info with Access Token","id":"2e817304-b236-41bb-b893-68429aa9c0f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The login endpoint will provide you with the access_token that you can pass, as in the header of a request as an Authorization parameter using the following format: Bearer .
You can authenticate with the NameShouts API v2.0 using an access token issued through an OAuth2.0 flow.
\nYou can use an access token (issued during an OAuth flow) to send API requests on behalf of the user that granted authorization.
\nPlease use the steps below to create a personal access token and verify your application with the NameShouts API v2. Remember, don't share your personal access token publicly or use it for different applications. Your token is for your app's eyes only!
\nLog in to your NameShouts account.
\nYou will find yourself on the NameShouts Dashboard.
\nNavigate to the Integrations Page.
\nClick on Get Started from the NameShouts API card.
\nIf you haven't used personal access tokens before, click on \"Get a token now\" in the Personal Access Tokens section.
\nIf you already have a token, choose \"Generate new token\" under Your personal access tokens.
When creating your personal access token, give it a name that makes sense to you.
Then, click \"Create Token\" and finally \"Copy Token\". (Please note that this is the last time the token will be visible to you.)
\nYou can now pass the personal access token Authorization: Bearer header. Please provide your bearer token in the Authorization header when making requests to protected resources.
You can check that your bearer token is valid by making sure it works for this endpoint.
\n","_postman_id":"08214005-6479-45dd-a7bb-29e8739621e4"},{"name":"Language","item":[{"name":"Get All Visible Languages","id":"41d4116e-640c-47fc-9eb6-22731dbbb0b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The API returns a list of all the available languages in NameShouts.
\nNote: The lang_id is the unique identifier which we will use to get the language name in the name object.
The Language Object gives you information corresponding to the language_id attribute. A GET request will give you the list of all languages that are available in NameShouts.
\nThe Language Object contains the following attributes:
\n","_postman_id":"3ae171ab-54e0-4e89-b82a-abda82a01c8e"},{"name":"Names","item":[{"name":"Get Name with Language","id":"ab74f56d-8da8-47c8-b3c2-1430b9012e6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/name/albert/german","description":"If you know the language for the name, the URI for the GET request should have the following format:
\nhttps://api.nameshouts.com/api/v2.0/name/{{name}}/german
\nThese are some of the main attributes that are returned by this request.
\nIf a name doesn't exist in our database, then the \"name_res\" will return null. \"sim_names\" will return an array of names similar to the missing name.
This request returns the info for names that are available in NameShouts for a particular language. The array object contains information about the names searched for the given language.
\n","urlObject":{"protocol":"https","path":["api","v2.0","name","albert-einstein","german"],"host":["api","nameshouts","com"],"query":[],"variable":[]}},"response":[{"id":"2233034e-add7-43ae-b003-e1603354401e","name":"Get Albert Einstein in German","originalRequest":{"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/name/albert-einstein/german"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 10 Aug 2022 02:34:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"activity_count\": {\n \"id\": 27157,\n \"created_at\": \"2022-08-04 02:50:51\",\n \"updated_at\": \"2022-08-10 02:34:47\",\n \"user_id\": 30508,\n \"count\": 46,\n \"limit\": 50\n },\n \"name_res\": [\n {\n \"id\": 33736,\n \"name\": \"Albert\",\n \"name_phonetic\": \"al-behrt\",\n \"gender\": \"male\",\n \"language_id\": 28,\n \"path_directory\": \"albert_de\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n },\n {\n \"id\": 34408,\n \"name\": \"Einstein\",\n \"name_phonetic\": \"ain-shtain\",\n \"gender\": \"male\",\n \"language_id\": 28,\n \"path_directory\": \"einstein_de\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n }\n ]\n}"}],"_postman_id":"13d25baf-0734-4d4d-9cf2-841c786dcfca"},{"name":"Get Name without language","id":"00c23fdc-0403-46f2-b8e9-53298126346e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/name/albert","description":"This endpoint returns all the available languages that a name exists for on the NameShouts database.
\nPlease note that using this will rapidly increase your search count. We recommend that you use this endpoint sparingly.
\n","urlObject":{"protocol":"https","path":["api","v2.0","name","albert"],"host":["api","nameshouts","com"],"query":[],"variable":[]}},"response":[{"id":"fcfa248c-59e6-49cf-935d-ee56e6bae72a","name":"Get Samara in all available languages","originalRequest":{"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/name/albert"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 10 Aug 2022 02:43:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"name_res_array\": [\n {\n \"id\": 1349,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sah-mah-rah\",\n \"gender\": \"female\",\n \"language_id\": 8,\n \"path_directory\": \"samara_be\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n },\n {\n \"id\": 11529,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sah-mah-rah\",\n \"gender\": \"female\",\n \"language_id\": 24,\n \"path_directory\": \"samara_fr\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n },\n {\n \"id\": 47367,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sa-ma-ra\",\n \"gender\": \"female\",\n \"language_id\": 29,\n \"path_directory\": \"samara_el\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n },\n {\n \"id\": 127961,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sah-mah-rah\",\n \"gender\": \"both\",\n \"language_id\": 69,\n \"path_directory\": \"samara_es\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n },\n {\n \"id\": 171292,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sah-mah-rah\",\n \"gender\": \"female\",\n \"language_id\": 3,\n \"path_directory\": \"samara_ar\",\n \"public\": 0,\n \"created_at\": \"2020-06-29 23:14:00\",\n \"updated_at\": \"2020-06-29 23:14:00\"\n },\n {\n \"id\": 214733,\n \"name\": \"Samara\",\n \"name_phonetic\": \"sah-mah-rah\",\n \"gender\": \"female\",\n \"language_id\": 34,\n \"path_directory\": \"samara_hi\",\n \"public\": 0,\n \"created_at\": \"2020-06-29 23:14:00\",\n \"updated_at\": \"2020-06-29 23:14:00\"\n },\n {\n \"id\": 359680,\n \"name\": \"Samara\",\n \"name_phonetic\": \"suh-maw-ruh\",\n \"gender\": \"female\",\n \"language_id\": 18,\n \"path_directory\": \"samara_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\"\n }\n ],\n \"activity_count\": {\n \"id\": 27157,\n \"created_at\": \"2022-08-04 02:50:51\",\n \"updated_at\": \"2022-08-10 02:43:40\",\n \"user_id\": 30508,\n \"count\": 49,\n \"limit\": 50\n }\n}"}],"_postman_id":"00c23fdc-0403-46f2-b8e9-53298126346e"},{"name":"Get Multiple Names without Language","id":"3a8c9426-2c15-4006-bdc8-d8fa60ac78e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/name/albert-einstein","description":"The API endpoint returns the results when multiple names are searched without specifying a language.
\nTo narrow down the languages where both these names are available:
\nLook for the main_res_array parameter on the returned object. Look for object keys where \"all_names_found\": is true. These are the languages where both these names exist.
This API endpoint allows you to request a missing name/s on our database.
\nPlease note that language is an optional parameter.
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","request-name"],"host":["api","nameshouts","com"],"query":[{"key":"name","value":"marsindg"},{"key":"language","value":"german"}],"variable":[]}},"response":[],"_postman_id":"d4e7edd8-9393-4d89-bcef-dfb21b3085f2"}],"id":"e7cfaf38-1c87-4a7b-8e25-5ac2ac39e0d9","description":"You can get the path of the audio file from the Name Object. If you do not specify the language in the GET request, you will have access to all the available pronunciations for the name.
\nThe Following Attributes may be returned as a response:
\n","_postman_id":"e7cfaf38-1c87-4a7b-8e25-5ac2ac39e0d9"},{"name":"Lists","item":[{"name":"Get all lists that is owned by user","id":"7f985f3c-bfdf-4b19-94eb-55de6df6ae9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns all active lists that belong to a user.
\nEvery registered user have atleast 1 active list called \"Favourites\".
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-lists"],"host":["api","nameshouts","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f985f3c-bfdf-4b19-94eb-55de6df6ae9e"},{"name":"Get All Names from List","id":"d344b25b-84be-4b9f-96a6-8cbc427cb640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns all the names that belong to a list. Names stored in lists are stored as name_groups.
\nThere are several attributes in the return object that are important:
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list"],"host":["api","nameshouts","com"],"query":[{"key":"user_list_id","value":"81564"}],"variable":[]}},"response":[{"id":"f8ea1369-cd05-4090-ad94-5d201c6d63c3","name":"Get all names from a specific user list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nameshouts.com/api/v2.0/user/user-list?user_list_id=27882","protocol":"https","host":["api","nameshouts","com"],"path":["api","v2.0","user","user-list"],"query":[{"key":"user_list_id","value":"27882"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 10 Aug 2022 03:05:21 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 27867,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:46:03\",\n \"updated_at\": \"2022-08-06 21:46:03\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 121720,\n \"name\": \"Saif\",\n \"name_phonetic\": \"sey-f\",\n \"gender\": \"male\",\n \"language_id\": 77,\n \"path_directory\": \"saif_ur\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27867,\n \"name_id\": 121720\n }\n },\n {\n \"id\": 343527,\n \"name\": \"Cheval\",\n \"name_phonetic\": \"shuh-vawl\",\n \"gender\": \"both\",\n \"language_id\": 18,\n \"path_directory\": \"cheval_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27867,\n \"name_id\": 343527\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11173,\n \"user_list_name_group_id\": 27867,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:46:03\",\n \"updated_at\": \"2022-08-06 21:46:03\"\n }\n },\n {\n \"id\": 27868,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:46:40\",\n \"updated_at\": \"2022-08-06 21:46:40\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 1056,\n \"name\": \"Naureen\",\n \"name_phonetic\": \"naw-reen\",\n \"gender\": \"female\",\n \"language_id\": 8,\n \"path_directory\": \"nowrine_be\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27868,\n \"name_id\": 1056\n }\n },\n {\n \"id\": 532,\n \"name\": \"Anwar\",\n \"name_phonetic\": \"ahn-oh-ar\",\n \"gender\": \"male\",\n \"language_id\": 8,\n \"path_directory\": \"anowar_be\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27868,\n \"name_id\": 532\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11174,\n \"user_list_name_group_id\": 27868,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:46:40\",\n \"updated_at\": \"2022-08-06 21:46:40\"\n }\n },\n {\n \"id\": 27869,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:47:01\",\n \"updated_at\": \"2022-08-06 21:47:01\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 7369,\n \"name\": \"Maxime\",\n \"name_phonetic\": \"mak-seem\",\n \"gender\": \"male\",\n \"language_id\": 24,\n \"path_directory\": \"maxime_fr\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27869,\n \"name_id\": 7369\n }\n },\n {\n \"id\": 377129,\n \"name\": \"Buteau\",\n \"name_phonetic\": \"boo-toh\",\n \"gender\": \"both\",\n \"language_id\": 24,\n \"path_directory\": \"buteau_fr\",\n \"public\": 0,\n \"created_at\": \"2021-09-01 19:03:00\",\n \"updated_at\": \"2021-09-01 19:03:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27869,\n \"name_id\": 377129\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11175,\n \"user_list_name_group_id\": 27869,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:47:01\",\n \"updated_at\": \"2022-08-06 21:47:01\"\n }\n },\n {\n \"id\": 27878,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-09 01:49:28\",\n \"updated_at\": \"2022-08-09 01:49:28\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 249271,\n \"name\": \"Benjamin\",\n \"name_phonetic\": \"ben-ja-min\",\n \"gender\": \"male\",\n \"language_id\": 18,\n \"path_directory\": \"benjamin_en\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27878,\n \"name_id\": 249271\n }\n },\n {\n \"id\": 266978,\n \"name\": \"Gardner\",\n \"name_phonetic\": \"gard-ner\",\n \"gender\": \"both\",\n \"language_id\": 18,\n \"path_directory\": \"gardner_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27878,\n \"name_id\": 266978\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11184,\n \"user_list_name_group_id\": 27878,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-09 01:49:28\",\n \"updated_at\": \"2022-08-09 01:49:28\"\n }\n }\n]"}],"_postman_id":"d344b25b-84be-4b9f-96a6-8cbc427cb640"},{"name":"Get All User Lists","id":"2f62c55c-1521-46ef-84c3-4f4aa41a06ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.nameshouts.com/api/v2.0/user/get-all-user-lists","description":"This endpoint returns all the names that belong to a list. Names stored in lists are stored as name_groups.
\nThere are several attributes in the return object that are important:
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","get-all-user-lists"],"host":["api","nameshouts","com"],"query":[],"variable":[]}},"response":[{"id":"b89238c8-32c8-4beb-9ff1-04afaddb979b","name":"Get all names from a specific user list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nameshouts.com/api/v2.0/user/user-list?user_list_id=27882","protocol":"https","host":["api","nameshouts","com"],"path":["api","v2.0","user","user-list"],"query":[{"key":"user_list_id","value":"27882"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 10 Aug 2022 03:05:21 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 27867,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:46:03\",\n \"updated_at\": \"2022-08-06 21:46:03\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 121720,\n \"name\": \"Saif\",\n \"name_phonetic\": \"sey-f\",\n \"gender\": \"male\",\n \"language_id\": 77,\n \"path_directory\": \"saif_ur\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27867,\n \"name_id\": 121720\n }\n },\n {\n \"id\": 343527,\n \"name\": \"Cheval\",\n \"name_phonetic\": \"shuh-vawl\",\n \"gender\": \"both\",\n \"language_id\": 18,\n \"path_directory\": \"cheval_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27867,\n \"name_id\": 343527\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11173,\n \"user_list_name_group_id\": 27867,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:46:03\",\n \"updated_at\": \"2022-08-06 21:46:03\"\n }\n },\n {\n \"id\": 27868,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:46:40\",\n \"updated_at\": \"2022-08-06 21:46:40\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 1056,\n \"name\": \"Naureen\",\n \"name_phonetic\": \"naw-reen\",\n \"gender\": \"female\",\n \"language_id\": 8,\n \"path_directory\": \"nowrine_be\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27868,\n \"name_id\": 1056\n }\n },\n {\n \"id\": 532,\n \"name\": \"Anwar\",\n \"name_phonetic\": \"ahn-oh-ar\",\n \"gender\": \"male\",\n \"language_id\": 8,\n \"path_directory\": \"anowar_be\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27868,\n \"name_id\": 532\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11174,\n \"user_list_name_group_id\": 27868,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:46:40\",\n \"updated_at\": \"2022-08-06 21:46:40\"\n }\n },\n {\n \"id\": 27869,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-06 21:47:01\",\n \"updated_at\": \"2022-08-06 21:47:01\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 7369,\n \"name\": \"Maxime\",\n \"name_phonetic\": \"mak-seem\",\n \"gender\": \"male\",\n \"language_id\": 24,\n \"path_directory\": \"maxime_fr\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27869,\n \"name_id\": 7369\n }\n },\n {\n \"id\": 377129,\n \"name\": \"Buteau\",\n \"name_phonetic\": \"boo-toh\",\n \"gender\": \"both\",\n \"language_id\": 24,\n \"path_directory\": \"buteau_fr\",\n \"public\": 0,\n \"created_at\": \"2021-09-01 19:03:00\",\n \"updated_at\": \"2021-09-01 19:03:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27869,\n \"name_id\": 377129\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11175,\n \"user_list_name_group_id\": 27869,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-06 21:47:01\",\n \"updated_at\": \"2022-08-06 21:47:01\"\n }\n },\n {\n \"id\": 27878,\n \"user_list_id\": 27882,\n \"created_at\": \"2022-08-09 01:49:28\",\n \"updated_at\": \"2022-08-09 01:49:28\",\n \"is_pinned\": 0,\n \"is_custom\": 0,\n \"is_missing\": 0,\n \"is_requested\": 0,\n \"names\": [\n {\n \"id\": 249271,\n \"name\": \"Benjamin\",\n \"name_phonetic\": \"ben-ja-min\",\n \"gender\": \"male\",\n \"language_id\": 18,\n \"path_directory\": \"benjamin_en\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27878,\n \"name_id\": 249271\n }\n },\n {\n \"id\": 266978,\n \"name\": \"Gardner\",\n \"name_phonetic\": \"gard-ner\",\n \"gender\": \"both\",\n \"language_id\": 18,\n \"path_directory\": \"gardner_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 27878,\n \"name_id\": 266978\n }\n }\n ],\n \"verified_name_group\": {\n \"id\": 11184,\n \"user_list_name_group_id\": 27878,\n \"is_verified\": 0,\n \"email\": null,\n \"created_at\": \"2022-08-09 01:49:28\",\n \"updated_at\": \"2022-08-09 01:49:28\"\n }\n }\n]"}],"_postman_id":"2f62c55c-1521-46ef-84c3-4f4aa41a06ab"},{"name":"Get Name information from List.","id":"dc4068d1-b087-45c1-9f9a-6b1ee551a787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns a specific name that belongs to a list.
\nNote: For a name that is recorded by a user, is_custom flag will be set to true. The response object for a custom name has slightly different attributes compared to a name from the NameShouts database.
\nNameShouts Default
\nThese are the relevant attributes from the response object when the name is not custom.
\nNameShouts User Recorded Name
\nFor the user recorded name, \"user_email\", \"is_custom\" and \"is_verified\" is similar. The name information for the full name is combined as shown in the example below.
\nTo get the verification name for a particular user, you would need the list_id and the verification_id from the response object.
\nOnce the user is logged into to NameShouts, if they click on the following link, they will be able to access the verification screen on the application.
\nhttps://app2.nameshouts.com/verify-list-name?id={verified_name_id}&list_id={user_list_id}
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list","get-name-group-from-user-list"],"host":["api","nameshouts","com"],"query":[{"disabled":true,"description":{"content":"An optional parameter to narrow down the search by providing the email of the user associated with the name. Using this parameter can provide more accurate results.
\n","type":"text/plain"},"key":"email","value":"sebastien@example.com"},{"key":"user_list_id","value":"81564"},{"key":"name","value":"Aaron-Benner"}],"variable":[]}},"response":[{"id":"950e301d-8111-40e8-baea-f207ddd2cb5b","name":"Get Name information from List - Default","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.nameshouts.com/api/v2.0/user/user-list/get-name-group-from-user-list?user_list_id=16694&name=benjamin-garder","protocol":"https","host":["api","nameshouts","com"],"path":["api","v2.0","user","user-list","get-name-group-from-user-list"],"query":[{"key":"user_list_id","value":"16694"},{"key":"email","value":"test2@test.com","description":"An optional parameter to narrow down the search by providing the email of the user associated with the name. Using this parameter can provide more accurate results.","type":"text","disabled":true},{"key":"name","value":"benjamin-garder"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 14 Sep 2023 04:20:12 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"names\": [\n {\n \"id\": 249271,\n \"name\": \"Benjamin\",\n \"name_phonetic\": \"ben-juh-min\",\n \"gender\": \"male\",\n \"language_id\": 18,\n \"path_directory\": \"benjamin_en\",\n \"public\": 1,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 55399,\n \"name_id\": 249271\n }\n },\n {\n \"id\": 266971,\n \"name\": \"Garder\",\n \"name_phonetic\": \"gar-der\",\n \"gender\": \"male\",\n \"language_id\": 18,\n \"path_directory\": \"garder_en\",\n \"public\": 0,\n \"created_at\": \"2020-06-30 00:08:00\",\n \"updated_at\": \"2020-06-30 00:08:00\",\n \"pivot\": {\n \"user_list_name_group_id\": 55399,\n \"name_id\": 266971\n }\n }\n ],\n \"user_email\": null,\n \"verified_name_id\": 28627,\n \"is_custom\": 0,\n \"is_verified\": 0\n }\n]"},{"id":"c0f1db74-689d-49a6-b827-329f612196bf","name":"Get Name from a User List-Custom Name","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/get-name-group-from-user-list?user_list_id=12&name=naureenr-anwar","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","get-name-group-from-user-list"],"query":[{"key":"user_list_id","value":"12"},{"key":"name","value":"naureenr-anwar"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 14 Sep 2023 04:30:16 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"name_group_id\": 58,\n \"names\": [\n {\n \"name\": \"Naureenr Anwar\",\n \"phonetic\": null,\n \"path_directory\": \"uploads/64eacca0cafaf1693109408_.mp3\",\n \"language_of_origin\": null,\n \"created_at\": \"2023-08-27T04:10:09.000000Z\",\n \"updated_at\": \"2023-08-27T04:10:09.000000Z\"\n }\n ],\n \"user_email\": \"test2@test.com\",\n \"verified_name_id\": 49,\n \"is_custom\": 1,\n \"is_verified\": 1\n}"}],"_postman_id":"dc4068d1-b087-45c1-9f9a-6b1ee551a787"},{"name":"Add Name to a User List","id":"11eaf8e7-fe5f-4bff-99e3-188670b5b206","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint adds a specific name to a list.
\nThe parameters required are as follows:
\nIf the name is successfully added to the list, the response object will indicate that by displaying this message. \"Name added to list.\"
If the name is missing from the database, the name will be automatically requested to NameShouts. \"Name not on database. Missing Name information sent to NameShouts.\"
If the name already exists, then the response object will return the following message. \"Name already in list\"
The examples below show the response for three scenarios.
\nNote: You can add the same name \"John Smith\" for two unique emails. You will not be able to add the same name with the same email more than once on the list.
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list","add-name-to-list"],"host":["api","nameshouts","com"],"query":[{"description":{"content":"The name to be added to the list. Please note that spaces between names should be delimited by hypens(-).
\n","type":"text/plain"},"key":"name","value":"John-Abrams2"},{"description":{"content":"The language of origin for the name. If the language of origin is not known, please use \"English\" as a default.
\n","type":"text/plain"},"key":"language","value":"English"},{"description":{"content":"The unique identifier for the list
\n","type":"text/plain"},"key":"user_list_id","value":"82076"},{"description":{"content":"Email is an optional parameter. This is the email of the person that the name belongs to.
\n","type":"text/plain"},"key":"email","value":"test@test2.com"}],"variable":[]}},"response":[{"id":"416cc67f-e5c7-4993-8ef9-96ca77e33cd7","name":"Added to List.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=John-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"John-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 05:56:35 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\"Name added to list.\""},{"id":"d9348e5a-fd88-4910-825b-55f43198a8da","name":"Missing from Database.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=Johnr-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"Johnr-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 05:57:03 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n \"Name not on database. Missing Name information sent to NameShouts.\"\n]"},{"id":"01b98448-ce36-4141-a011-7ebbffa23415","name":"Already on List.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=John-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"John-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 06:52:48 GMT"}],"cookie":[],"responseTime":null,"body":"\"Name already in list\""}],"_postman_id":"11eaf8e7-fe5f-4bff-99e3-188670b5b206"},{"name":"Update Name from a User List","id":"9ac13881-d090-41c2-b022-c1379fc71c46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Maxime Buteau","type":"text","description":"The name you want to modify on the list.
\n"},{"key":"name_group_id","value":"100048","description":"The unique idea of the name on the list. You can locate this from \"Get Name Information from List\" endpoint.
\n","type":"text","uuid":"abff792e-50ed-4db4-81ee-f923deef14d1"},{"key":"phonetic","value":"mak-seem boo-toh","description":"The respelling for the name.
\n","type":"text","uuid":"1afbbb82-0dbe-4161-9782-cb5ad7df5cfa"},{"key":"lang","value":"French","type":"text","description":"The language of origin.
\n"},{"key":"audio","description":"The updated audio
\n","type":"file","uuid":"9eb47012-5074-4fb8-99f2-122d79e81cab","value":null}]},"url":"https://api.nameshouts.com/api/v2.0/user/user-list/edit-name","description":"Updates a name on a list. You can modify the phonetic spelling, language of origin, and audio.
\nThe associated email address can’t be changed. To update the email, delete the existing entry and create a new one.
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list","edit-name"],"host":["api","nameshouts","com"],"query":[],"variable":[]}},"response":[{"id":"9d76fbb5-4e21-483a-85fd-0ab5f199a1ff","name":"Added to List.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=John-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"John-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 05:56:35 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\"Name added to list.\""},{"id":"b058d2ca-ef95-4105-9bd2-63df2d235ace","name":"Missing from Database.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=Johnr-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"Johnr-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 05:57:03 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n \"Name not on database. Missing Name information sent to NameShouts.\"\n]"},{"id":"9de13d24-3a06-447a-9bc1-bece76dc8819","name":"Already on List.","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{base_url}}/api/v2.0/user/user-list/add-name-to-list?name=John-Smith&language=English&user_list_id=12&email=test4@test.com","host":["{{base_url}}"],"path":["api","v2.0","user","user-list","add-name-to-list"],"query":[{"key":"name","value":"John-Smith"},{"key":"language","value":"English"},{"key":"user_list_id","value":"12"},{"key":"email","value":"test4@test.com"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.23.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.4.33"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 20 Sep 2023 06:52:48 GMT"}],"cookie":[],"responseTime":null,"body":"\"Name already in list\""}],"_postman_id":"9ac13881-d090-41c2-b022-c1379fc71c46"},{"name":"Remove Name from List","id":"fc3095f0-aa9b-429e-8446-9b2d3f246295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns a specific name that belongs to a list.
\nYou need to provide two input parameters to remove the name from a list.
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list","remove-name-from-list"],"host":["api","nameshouts","com"],"query":[{"key":"name_group_id","value":"94812"},{"key":"user_list_id","value":"49909"}],"variable":[]}},"response":[{"id":"62bba4d8-f485-4651-805f-982221a6c766","name":"Remove Name from List","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.nameshouts.com/api/v2.0/user/user-list/remove-name-from-list?name_group_id=27855&user_list_id=16694","protocol":"https","host":["api","nameshouts","com"],"path":["api","v2.0","user","user-list","remove-name-from-list"],"query":[{"key":"name_group_id","value":"27855"},{"key":"user_list_id","value":"16694"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 14 Sep 2023 04:00:55 GMT"}],"cookie":[],"responseTime":null,"body":"\"Name successfully removed from list.\""}],"_postman_id":"fc3095f0-aa9b-429e-8446-9b2d3f246295"},{"name":"Get Public Link for name","id":"660df848-1da6-4a5f-9bed-dc587f42a0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint returns a link to the page that contains the name card for a particular name on a list.
\nA user can add this link to their social profile or their email signature.
\nPlease note that this generates a publicly available link that anyone can access without having to sign in to NameShouts. If a user has recorded their own name, their voice data will be available on the open internet.
\nTo access the custom page link for your company, please add \"?source={company_name}\" to the generated link.
You need to provide the following input parameter to get the signature link:
\n","urlObject":{"protocol":"https","path":["api","v2.0","user","user-list","get-signature-link"],"host":["api","nameshouts","com"],"query":[{"key":"name_group_id","value":"80658"}],"variable":[]}},"response":[],"_postman_id":"660df848-1da6-4a5f-9bed-dc587f42a0ec"}],"id":"e0de1287-a7a2-4066-978d-a7bffe6a1456","description":"Lists are a new addition for NameShouts v2.0. Lists allow you to create and maintain your own custom list of names. You can learn more about creating and maintaining lists by visiting our help center.
\nUsing our API, you can get all the available names that are on a list. You can program your application so that the pronunciations are first retrieved from your custom list before using the NameShouts database as a fallback.
\nThe list object comprises of the following relevant attributes:
\n","_postman_id":"e0de1287-a7a2-4066-978d-a7bffe6a1456"}],"event":[{"listen":"prerequest","script":{"id":"7111a8b3-dd95-4881-ab15-94daae39bba3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c2f0ec6-a20c-4eef-8273-d094e2f7fe8e","type":"text/javascript","exec":[""]}}],"variable":[{"key":"your email","value":"{{Your email }}"},{"key":"Your password","value":"{{Your passwordl }}"},{"key":"person-name","value":"albert"},{"key":"language","value":"german"},{"key":"first-name","value":"albert"},{"key":"last-name","value":"einstein"},{"key":"missing-name","value":"marsindg"}]}