{ "uuid": "8a555464-113c-4c1b-9207-c43cd343a6fa", "lastMigration": 29, "name": "DaniWeb Connect API", "endpointPrefix": "connect/api/v4", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "081d4bd1-2186-4829-ba7a-cababa3c7ea8", "documentation": "Fetch all Daniapps that are currently in production mode.", "method": "get", "endpoint": "apps", "responses": [ { "uuid": "e7a01cec-0cda-4429-9045-ca6c7470b832", "body": "{\n \"data\": [\n {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3717d3ac-1fb4-4ec3-ae6f-b7e6a2362ff7", "documentation": "Fetch an array of Daniapps that are currently in production mode.", "method": "get", "endpoint": "apps/:ID", "responses": [ { "uuid": "19366780-d3a7-4075-88c4-0858ea39b748", "body": "{\n \"data\": [\n {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4c6dd4a8-1ead-4580-9c42-5986f63187b9", "documentation": "Fetch all Daniapp audience segments that comprise the current access token's bubble.", "method": "get", "endpoint": "audiences", "responses": [ { "uuid": "ce5f4a6c-eebe-4daa-942d-7d1c7699130b", "body": "{\n \"data\": [\n {\n \"about\": {\n \"name\": \"\"\n },\n \"id\": {{faker 'number.int' max=99999}}\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0efa0bd-7ad6-47a3-a6a5-6ec38b3c4699", "documentation": "Fetch an array of Daniapp audience segments that comprise the current access token's bubble.", "method": "get", "endpoint": "audiences/:ID", "responses": [ { "uuid": "1416f2fd-ef61-49f7-8b82-63c40b43ce6c", "body": "{\n \"data\": [\n {\n \"about\": {\n \"name\": \"\"\n },\n \"id\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f1bc4c2-1c59-44f7-9837-9223fec7cad9", "documentation": "Create a membership record for the OAuth'ed end-user based on the current audience segment/bubble combination.", "method": "post", "endpoint": "audiences/:ID/memberships", "responses": [ { "uuid": "9763f8d3-07dd-4665-a6ad-06d907dfddf6", "body": "{\n \"data\": {\n \"audience\": {\n \"id\": {{faker 'number.int' max=99999}}\n },\n \"member\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b70ed4d4-29d8-44d6-aa9f-d43c9017cbab", "documentation": "Retrieve an array of names and locations, filtered by category, that begin with the query string passed in. Ideally used for search autocomplete dropdowns, as the search functionality filters against name and location. The four potential categories are: `conversations` for names of users you are in existing conversations with; `matches` for names of users you have previously skipped over; `people` for names of all other users; `locations` for locations of users. Only users and their locations who exist with the current access token's bubble are considered.", "method": "get", "endpoint": "autocompletes", "responses": [ { "uuid": "8a26d679-3e7b-4e1e-8f3f-d4e465b4537e", "body": "{\n \"data\": {\n \"conversations\": [\n \"\"\n ],\n \"locations\": [\n \"\"\n ],\n \"matches\": [\n \"\"\n ],\n \"people\": [\n \"\"\n ]\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4880362-a2b5-4b17-a46f-4676f0486511", "documentation": "Paginated report of information about messages contributed by conversation and date. Only conversations that exist within the current access token's bubble are considered in the calculations. Optionally roll up all conversations to retrieve one record per date. Optionally specify a date formatted as YYYY-MM-DD to retrieve information just from the single date, along with additional navigational information, which is useful when generating a transcript for a single day and wanting to reference the previous and next days there were messages.", "method": "post", "endpoint": "conversations/schedules", "responses": [ { "uuid": "39af28ad-a486-401f-930f-3fc06486b4de", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ff45181-4450-4d15-acb0-96b05da06adc", "documentation": "Fetch messages authored from within the current bubble that match a query string passed in as a search parameter along with their relevancy score.", "method": "post", "endpoint": "conversations/searches", "responses": [ { "uuid": "ea211e28-6931-4b79-85f5-6643caf1aa64", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "46f6461a-d5fb-421c-8bc5-bf56010f69db", "documentation": "Retrieve conversations that you are participating in with users who exists within the same bubble, along with your current relationship with the conversations. The user_a / user_b properties of the conversation are populated with as much data as is available if the user is not you. If the user is you, only the id field is populated. There is a separate status endpoint to retrieve relationship information for individual conversations. Optionally filter: 'new' to only show conversations with messages you haven't yet seen; 'introductions' to only show conversations where users have introduced themselves to you but nothing more; 'unreplied' to only show conversations where you have introduced yourself to other users but nothing more; 'notifications' to show all conversations where the other user was the last person to message. Optionally only show conversations engaging within the existing access token's bubble. This report is limited to your ~500-1000 most recently active conversations you've engaged in within current the access token's bubble.", "method": "get", "endpoint": "conversations/statuses", "responses": [ { "uuid": "456fb0e6-b2f6-440f-9f54-c72619655d37", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4180546d-05cf-486a-83ca-292b63eba115", "documentation": "Fetch an array of conversations. You can only retrieve conversations with users who exist within the current access token's bubble.", "method": "get", "endpoint": "conversations/:ID", "responses": [ { "uuid": "d390b64e-5fd0-4faf-acb1-d53189ffd18f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "769cf55b-7ee4-4112-bd45-3ba205a4e75f", "documentation": "Retrieve the last {limit} messages in the conversation, provided the conversations exist within the current access token's bubble. If a timeout is 0 or greater, the batch is sorted oldest first. Otherwise, if timeout is a negative number, the transcript is paginated and sorted newest first. Specify a timeout for long polling (which delays the server sending back results for up to n seconds or until results are available, whichever comes first), or default to 0 for immediate results. Optionally record your status as online along with sharing the latest message you've seen with the other conversation participant. Optionally specify a gt_message_id to retrieve only messages with an ID greater than that specified (such as greater than the latest message ID received in the last poll). Optionally only poll for messages authored by the other person in the conversation, and echo messages authored by you when sending, for a perceived increase in performance. Optionally only retrieve messages that were posted from within the current access token's bubble. Optionally specify a date formatted as YYYY-MM-DD to retrieve a transcript of messages from a single day. When record_seen is set to true, the new message count for the conversation is reset to zero.", "method": "get", "endpoint": "conversations/:ID/messages", "responses": [ { "uuid": "96bdae92-0096-4502-a8d6-17bad63099a6", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9039e32-6b55-4fa9-bd70-23c10ef305f0", "documentation": "Post a message to a conversation that is with a user who exists within the current access token's bubble. Optionally specify whether emoticons should be parsed into smiley images. Optionally specify whether the message should be bubbled within the app. Additionally, optionally attach a single metadata key/value pair to the message upon submission.", "method": "post", "endpoint": "conversations/:ID/messages", "responses": [ { "uuid": "7c89e33e-0395-4d12-a63c-0e3de99436a1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "176d2f8c-5b70-4017-a70d-236a82615984", "documentation": "Paginated report of information about messages contributed by conversation and date. Only conversations that exist within the current access token's bubble are considered in the calculations. Optionally roll up all conversations to retrieve one record per date. Optionally specify a date formatted as YYYY-MM-DD to retrieve information just from the single date, along with additional navigational information, which is useful when generating a transcript for a single day and wanting to reference the previous and next days there were messages within the conversation(s).", "method": "post", "endpoint": "conversations/:ID/schedules", "responses": [ { "uuid": "29b4ee71-24b1-4e9d-a331-afde4f842b42", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d43ea7bb-d4de-4c9c-b9ac-533863494446", "documentation": "Fetch messages authored from within specified conversations that match a query string passed in as a search parameter along with their relevancy score.", "method": "post", "endpoint": "conversations/:ID/searches", "responses": [ { "uuid": "602b1376-921a-4770-afa9-c365ce0c6763", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aebaef1e-b317-4bd1-a41f-93b62de409f7", "documentation": "Status information about your current relationship with one or more conversations you participating in, provided the conversations exist within the current access token's bubble.", "method": "get", "endpoint": "conversations/:ID/statuses", "responses": [ { "uuid": "4d59ab1b-0450-4ca1-a69c-1916341fb12d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "428aa99b-0a7f-4ca3-88e7-9c13c1a461a1", "documentation": "Archive or unarchive a conversation that is with a user who exists within the same bubble.", "method": "patch", "endpoint": "conversations/:ID/statuses", "responses": [ { "uuid": "c80ad7c0-b3ba-45d9-b79d-6d8fbea2f34f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b7e4acb8-07a4-45a4-ad8b-c31b206d3015", "documentation": "Fetch an array of all groups that were created by users existing within the current access token's bubble. The groups must be either Public or you must be a member of them. Unlisted and Private groups that you are not a member of are not listed.", "method": "get", "endpoint": "groups", "responses": [ { "uuid": "5309bbd6-d4cd-402e-935e-46885efc96e0", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "66b50ca0-4367-499f-9d4b-65bb99968af0", "documentation": "Create a new group for other members to join. Any user who is using an access token whose bubble you exist in can join your group provided it is not a private group. Private groups can only be joined by members who know its passphrase. Unlisted groups can be joined by anybody as long as they know the Group ID, but they are not referenced anywhere to non-members. Public groups can be joined by anybody, are discoverable, and anyone can see the public groups a user is a member of, provided the group owner exists in their access token's bubble. Groups each have their own discussions, transcripts, schedules, and ability to list and search their members.", "method": "post", "endpoint": "groups", "responses": [ { "uuid": "f821ef9c-b4ff-42e7-8b0c-f0487c6d1d6b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e81f2e15-e1dc-4974-a686-71f6e6b59339", "documentation": "Paginated listing of messages filtered by arbitrary metadata criteria. Messages must match on all key/value pairs passed in. Messages may only match on one value of an array passed in. However, messages are sorted based on how many distinct values they match on (most matches first).", "method": "post", "endpoint": "groups/messages/metadata/filters", "responses": [ { "uuid": "1cd2432c-3c6f-4803-b562-98757eb58f01", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c67d4e60-f794-4d0a-8280-e9e0bb7fe668", "documentation": "Delete an array of group messages. You must be the owner or moderator of the group.", "method": "delete", "endpoint": "groups/messages/:ID", "responses": [ { "uuid": "2d5bf2ed-68f8-4bb2-8229-a963f33fc54f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7baa3860-73d2-4aa0-a1d6-cf86351bbaef", "documentation": "Fetch an array of group messages. You can only retrieve messages authored by you or by users existing within the current access token's bubble.", "method": "get", "endpoint": "groups/messages/:ID", "responses": [ { "uuid": "def7699f-b43d-42a8-8a10-665498ff087c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ec396fdf-98d3-4c11-850b-11ff99c62e9a", "documentation": "Retrieve all key/value pairs attached to the current message that you have access to, so long as the user who created the group exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble.", "method": "get", "endpoint": "groups/messages/:ID/metadata", "responses": [ { "uuid": "6d3b0ff7-febc-4c1c-be3f-270222457f8e", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4b2f2ec3-397b-4d61-9e1a-5abe63abeb26", "documentation": "Attach one-to-many key/value pairs of metadata to a group message, so long as the user who authored the message exists within the current access token's bubble and you are a member of their group. A key is unique for each author/bubble combination. Attaching metadata with an existing key that was previously created by you, from within the same bubble, overwrites the key with the new value or set of values. The privacy setting allows you to specify who will have access to the metadata: Public metadata by anyone using an access token which grants them access to the user who authored the message and who is also a member of the group the message belongs to; Bubbled metadata by anyone using an access token existing within the current bubble who is also a member of the group the message belongs to; User metadata by you, so long as you are using an access token which grants you access to the user who authored the message and you remain a member of the group; Private metadata by you, so long as you are using an access token existing within the current bubble and you remain a member of the group.", "method": "post", "endpoint": "groups/messages/:ID/metadata", "responses": [ { "uuid": "66d2aa83-03cf-4c53-8920-eec2247034fb", "body": "{\n \"data\": {},\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de19e54e-42bc-4bc8-a4ad-812047605090", "documentation": "Retrieve all key/value pairs attached to the current message that you have access to, so long as the user who created the group exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble. Metadata will be grouped by key.", "method": "get", "endpoint": "groups/messages/:ID/metadata/collections", "responses": [ { "uuid": "3308edab-230e-417b-abb2-2fbe2059ee4d", "body": "{\n \"data\": {}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eb11475c-1819-478a-af57-97ef1a70e106", "documentation": "Paginated report of information about messages contributed by group and date. Only groups you're a member of and group messages authored by users the current access token has access to are considered in the calculations. Optionally roll up all groups to retrieve one record per date. Optionally specify a date formatted as YYYY-MM-DD to retrieve information just from the single date, along with additional navigational information, which is useful when generating a transcript for a single day and wanting to reference the previous and next days there were messages.", "method": "post", "endpoint": "groups/schedules", "responses": [ { "uuid": "2e810743-25ae-45b0-bd9e-d2c452493a32", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "32629b98-e8ed-4642-8523-14537fd04deb", "documentation": "Retrieve groups that were created by users within the current access token's bubble, along with your current relationship with the groups. The groups must be either Public or you must be a member of them. Unlisted and Private groups that you are not a member of are not listed. Optionally only retrieve groups that you are a member of.", "method": "get", "endpoint": "groups/statuses", "responses": [ { "uuid": "b61518f2-58e5-4b67-a4f9-1f87956e2421", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a4177f8-db00-49a6-81d0-b08b4f1ac6f0", "documentation": "Fetch an array of groups. You can only retrieve groups created by users existing within the current access token's bubble.", "method": "get", "endpoint": "groups/:ID", "responses": [ { "uuid": "70934dea-9f3a-43d5-8044-a2e5f6698569", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "148fe18d-0fe5-4e4c-a301-8cf05436be8f", "documentation": "Modify a group you previously created.", "method": "patch", "endpoint": "groups/:ID", "responses": [ { "uuid": "fd76a6cd-32f8-469d-901a-c618e8b8abef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d1173be-71f9-4cce-bd8e-74a1e31b5cbe", "documentation": "Leave a group that you are a member of and that was created by a user who exists within the current access token's bubble.", "method": "delete", "endpoint": "groups/:ID/memberships", "responses": [ { "uuid": "465aed93-fd35-44b7-a7dd-c69d1441d6ec", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "163fcb3d-e969-4e1a-80ab-e368a03483fd", "documentation": "Fetch an array of users who are members of specific groups that you are also a member of. You can only retrieve users existing within the current access token's bubble.", "method": "get", "endpoint": "groups/:ID/memberships", "responses": [ { "uuid": "105c7705-6c5d-4ed3-89dc-44a1b30d6f75", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6fbfa749-0dc3-495a-b332-6604a6a0fd75", "documentation": "Promote or demote a member's privileges within a group that you created. The user must exist within the current access token's bubble and be an existing member of the group.", "method": "patch", "endpoint": "groups/:ID/memberships", "responses": [ { "uuid": "1e940c1e-1473-4460-82e4-9c0f38282b41", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4b420cb7-f47d-4224-ba8d-c4bf0a298675", "documentation": "Join a group that was created by a user who exists within the current access token's bubble, or join other users into a group that you created. If you are the group owner, you can pass in a user_id to create membership records for a user you are in a conversation with. The user must exist within the current access token's bubble. If the group is private, you must successfully pass in its passphrase in order to join. You can obtain the passphrase from the group's owner.", "method": "post", "endpoint": "groups/:ID/memberships", "responses": [ { "uuid": "5ef5ba71-ea60-46bb-a048-1e7a6dcfbdef", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d2949fb-023b-4d13-a50b-10fc85c464fe", "documentation": "Retrieve the last {limit} messages in the group, for messages authored by users within the current access token's bubble. If a timeout is 0 or greater, the batch is sorted oldest first. Otherwise, if timeout is a negative number, the transcript is paginated and sorted newest first. Specify a timeout for long polling (which delays the server sending back results for up to n seconds or until results are available, whichever comes first), or default to 0 for immediate results. Optionally record your status as online along with sharing the latest message you've seen with other group members. Optionally specify a gt_message_id to retrieve only messages with an ID greater than that specified (such as greater than the latest message ID received in the last poll). Optionally only poll for messages authored by other members of the group, and echo messages authored by you when sending, for a perceived increase in performance. Optionally only retrieve messages that were posted from within the current access token's bubble. Optionally specify a date formatted as YYYY-MM-DD to retrieve a transcript of messages from a single day. When record_seen is set to true, the new message count for the group is reset to zero.", "method": "get", "endpoint": "groups/:ID/messages", "responses": [ { "uuid": "46379fea-e44f-4d49-ae0d-bf7f2efda0c9", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aedcb0c4-fece-4f1e-a4d0-8295d46702cd", "documentation": "Post a message to a group that you are a member of and that was created by a user who exists within the current access token's bubble. Optionally specify whether emoticons should be parsed into smiley images. Additionally, optionally attach a single metadata key/value pair to the group message upon submission.", "method": "post", "endpoint": "groups/:ID/messages", "responses": [ { "uuid": "edd9814a-d638-4d8b-9249-8f5636ff8b11", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5100cfac-2868-4c19-b72f-716c09270952", "documentation": "Paginated report of information about group messages contributed by conversation and date. Only groups you're a member of and group messages authored by users existing within the current access token's bubble are considered in the calculations. Optionally roll up all groups to retrieve one record per date. Optionally specify a date formatted as YYYY-MM-DD to retrieve information just from the single date, along with additional navigational information, which is useful when generating a transcript for a single day and wanting to reference the previous and next days there were messages within the group discussion(s).", "method": "post", "endpoint": "groups/:ID/schedules", "responses": [ { "uuid": "f5847e2b-91e3-4916-b542-97d0c72dc69f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "89e95594-a7f7-40c2-a88d-19b9735e80b7", "documentation": "Status information about your current relationship with one or more groups you are a member of, provided the users who created the groups exist within the current access token's bubble.", "method": "get", "endpoint": "groups/:ID/statuses", "responses": [ { "uuid": "adb8b85a-22f4-488b-b064-a4d1b2db2a79", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df85042a-d244-4a0a-88a6-57a8d4d76974", "documentation": "", "method": "get", "endpoint": "industries", "responses": [ { "uuid": "0b80c1df-ae62-4795-94a3-050585012ec7", "body": "{\n \"data\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d8145937-232a-41b4-af85-55243e2886b3", "documentation": "", "method": "post", "endpoint": "markdown", "responses": [ { "uuid": "e6b2092b-6527-43a2-8c4b-5eaf6768fabb", "body": "{\n \"data\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "964efdc4-2ebd-481e-8362-bbd65a806731", "documentation": "", "method": "get", "endpoint": "markdown/emoticons", "responses": [ { "uuid": "85a1d0fb-4844-4cd7-92b8-01b01d86b993", "body": "{\n \"data\": [\n {\n \"alt\": \"\",\n \"emoticon\": \"\",\n \"image\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d71180e-bd0b-423e-95b9-573d5bde1605", "documentation": "Paginated listing of messages filtered by arbitrary metadata criteria. Messages must match on all key/value pairs passed in. Messages may only match on one value of an array passed in. However, messages are sorted based on how many distinct values they match on (most matches first).", "method": "post", "endpoint": "messages/metadata/filters", "responses": [ { "uuid": "385f1628-d9fd-470d-8cca-a18faba28744", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "032696b9-151a-4cd1-930e-2fef15128a1c", "documentation": "Fetch an array of messages. You can only retrieve messages authored by you or by users who exist within the current access token's bubble.", "method": "get", "endpoint": "messages/:ID", "responses": [ { "uuid": "d8112f13-c556-4207-80ff-f88d0f3f5a8c", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "028774e2-0c2e-42fc-9917-d59ef1025fa8", "documentation": "Retrieve all key/value pairs attached to the current message that you have access to, so long as the user who authored the message exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble.", "method": "get", "endpoint": "messages/:ID/metadata", "responses": [ { "uuid": "559d42ca-6939-44cb-bdbc-089dfca2badf", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9ab3ece3-a3d9-427d-bb26-c5e796d99c9e", "documentation": "Attach one-to-many key/value pairs of metadata to a message, so long as the user who authored the message exists within the current access token's bubble. A key is unique for each author/bubble combination. Attaching metadata with an existing key that was previously created by you, from within the same bubble, overwrites the key with the new value or set of values. The privacy setting allows you to specify who will have access to the metadata: Public metadata by you or the other user in the message's conversation, using an access token which grants you access to the user who authored the message, if it wasn't you; Bubbled metadata by you or the other user in the message's conversation, using an access token existing within the current bubble; User metadata by you, so long as you are using an access token which grants you access to the user who authored the message, if it wasn't you; Private metadata by you, so long as you are using an access token existing within the current bubble.", "method": "post", "endpoint": "messages/:ID/metadata", "responses": [ { "uuid": "944fc5a0-9040-478f-b828-c9165c523305", "body": "{\n \"data\": {},\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd31e385-a877-475b-bac7-0ad9c509a8c4", "documentation": "Retrieve all key/value pairs attached to the current message that you have access to, so long as the user who authored the message exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble. Metadata will be grouped by key.", "method": "get", "endpoint": "messages/:ID/metadata/collections", "responses": [ { "uuid": "9d896f1f-33d0-4958-aaae-8d8cc9b2a6bd", "body": "{\n \"data\": {}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d7a2599-5a3f-43ca-ba63-6e9e0dae3a35", "documentation": "Update the OAuth'ed end user's Curriculum Vitae by adding a position.", "method": "post", "endpoint": "positions", "responses": [ { "uuid": "a763a8cc-9106-46ba-9a1f-5a5991c4d2fe", "body": "{\n \"data\": {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"category\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"organization\": {\n \"industry\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"ticker\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n },\n \"role\": {\n \"end_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"start_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"summary\": \"\",\n \"title\": \"\"\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bdf70a81-2b06-4943-8f66-bd1563f014c5", "documentation": "Remove an item from the OAuth'ed end user's Curriculum Vitae.", "method": "delete", "endpoint": "positions/:ID", "responses": [ { "uuid": "f5d8dc5e-6505-4f33-b496-8de7f9537617", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0ec863d2-6b0e-4834-8339-22a256ccb0fc", "documentation": "Update the OAuth'ed end user's Curriculum Vitae by modifying an existing position.", "method": "patch", "endpoint": "positions/:ID", "responses": [ { "uuid": "77e6abbe-ebfe-4d33-8f0d-db295a3e1447", "body": "{\n \"data\": {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"category\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"organization\": {\n \"industry\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"ticker\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n },\n \"role\": {\n \"end_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"start_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"summary\": \"\",\n \"title\": \"\"\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5e83e22e-b629-4053-9243-2096d95bb693", "documentation": "Fetch an array of users that you've been matched with, connected with, skipped, or muted. You can only retrieve users existing within the current access token's bubble. This report may be limited to the last ~500-1000 users you've communicated with within the access token's bubble. Matches are always ordered by synergy, and the order_by parameter is ignored. You can only retrieve bubbled users when retrieving matches, and the bubbled parameter is ignored otherwise. Your 100 best algorithmic matches are based on: Complementary data submitted to Profiles, CVs, and Metadata; Complementary data acquired from third-parties; Location information; Many behavioral data points, such as how responsive users are to connections; Degrees of separation (mutual connections); etc. You may connect with 3 of these algorithmic matches per day for free. However, new members are allowed a grace period of additional daily matches. Each time you choose to meet or mute one of your algorithmic matches, a new match is introduced.", "method": "get", "endpoint": "users", "responses": [ { "uuid": "4d06fbd9-72ea-4472-b5d8-f0567bce4c35", "body": "{\n \"data\": [\n {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9b2b848-eae1-4c63-92b7-8bcae60f5db1", "documentation": "Invite users to into your current access token's bubble by having Dazah send out email invitations on your behalf. The invitation sends users to begin the OAuth flow for the current application (based on the settings specified in the application's profile), and therefore they will be redirected to the application upon signing up / logging in. Upon doing so, if they aren't already, they will automatically be connected with you as well. If your current access token does not escape the bubble, the invitation will specify you wish to connect within the application's name. If your current access token escapes the bubble, the invitation will specify you wish to connect within Dazah. Submit either a list of emails, or a LinkedIn or Outlook CSV file. You can retrieve your LinkedIn CSV file by exporting your LinkedIn Connections at https://www.linkedin.com/people/export-settings. You can retrieve your Outlook CSV file by using the Outlook Import and Export Wizard. This endpoint buckets the invitations into four categories: Existing invites are existing users who are already connected with you within the current bubble, and are therefore not emailed; Discovered invites are existing Dazah users who are available to be connected with within the current bubble, and are therefore not emailed. Now that they have been discovered, the users/{:ID}/meet API endpoint may be used to connect with them; Invalid invites are existing Dazah users who are unavailable to be connected with, because they have deactivated accounts, are muting you, etc., and are therefore not emailed; Emailed invites are queued to receive an invitation within approximately 1 hour. Note that if you are attempting to invite an existing Dazah user who does not currently exist within your current access token's bubble, they will fall within the Discovered bucket if your current access token escapes the bubble, but will be emailed an invitation to join the application if your current access token does not escape the bubble.", "method": "post", "endpoint": "users/invites", "responses": [ { "uuid": "e91fd89f-9fe0-405a-b9eb-b8a89785ca7f", "body": "{\n \"data\": {\n \"discovered\": {\n \"users\": [\n {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n ]\n },\n \"emailed\": {\n \"emails\": [\n \"\"\n ]\n },\n \"existing\": {\n \"conversations\": [\n {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n ]\n },\n \"invalid\": {\n \"emails\": [\n \"\"\n ]\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9ee92a6-1bbd-48a3-b75c-0a58818a7eb3", "documentation": "Paginated listing of users filtered by arbitrary metadata criteria. Users must match on all key/value pairs passed in. Users may only match on one value of an array passed in. However, users are sorted based on how many distinct values they match on (most matches first).", "method": "post", "endpoint": "users/metadata/filters", "responses": [ { "uuid": "727266a8-4e16-4070-aece-55f3c42c87b1", "body": "{\n \"data\": [\n {\n \"matched_metadata\": {},\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "03baac99-55fc-4777-9ca1-19ae7c1485fa", "documentation": "Fetch an array of users that are geographically close to a set of coordinates. You can only retrieve users existing within the current access token's bubble.", "method": "get", "endpoint": "users/nearby", "responses": [ { "uuid": "3a04e991-95cb-4a7a-abe7-c97dfff5db6e", "body": "{\n \"data\": [\n {\n \"distance_away\": {\n \"miles\": {{faker 'number.float'}}\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8943138f-227c-4e3f-8aa6-5334af50440d", "documentation": "Filter and perform a weighted search against user profile fields, CV fields, and metadata by specifying a string to search on for each individual field. By default, results are filtered such that all words in the string must exist, unless you seprate the words with OR. To perform a weighted search (as opposed to filtering), specify the weight (from 0-100) the search algorithm should assign to the field. You can optionally exclude users who you are already in or not in conversations with, exclude users who you previously skipped, or exclude users who you are muting. By doing so, you can effectively customize your own matching algorithm. You can specify geo coordinates to only find users a certain distance away from a specific location, or only find users within a certain distance from the OAuth'ed end-user's last known location. If your app utilizes multiple audience segments, you can specify which audiences you would like to search. You can also limit users to just those who have been recently active. You can also choose to only receive users originating from the current access token's bubble. Only users existing within the current access token's bubble will be matched, and you can only search within a group created by a bubbled user.", "method": "post", "endpoint": "users/searches", "responses": [ { "uuid": "27b3d1a8-3411-4c35-827d-f3f1724280de", "body": "{\n \"data\": [\n {\n \"relevance\": {\n \"score\": {{faker 'number.float'}}\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5c9deb2-f0ec-4cab-bb34-5fbaa871923d", "documentation": "Fetch an array of users. You can only retrieve users existing within the current access token's bubble.", "method": "get", "endpoint": "users/:ID", "responses": [ { "uuid": "3d0fa549-346c-4d49-805a-b245ddf5e52c", "body": "{\n \"data\": [\n {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "78a37580-d02c-430a-b847-b243555f4a0e", "documentation": "You can only retrieve groups that were created by users existing within the current access token's bubble.", "method": "get", "endpoint": "users/:ID/groups", "responses": [ { "uuid": "45d7d064-2adf-4379-bc68-63091234141b", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "caaf2e88-fe84-43fb-aded-35a1312a044c", "documentation": "Paginated transcript of group messages authored by an individual user who exists within the current access token's bubble. Messages are sorted oldest to newest.", "method": "get", "endpoint": "users/:ID/groups/messages", "responses": [ { "uuid": "876c30a3-8853-4b2c-8d7b-a3448789b808", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44747c0b-8982-4c3b-a33a-c5fe10cd61a1", "documentation": "Initiate a conversation with a user who exists within the current access token's bubble by sending them an introductory message. If you aren't already in a conversation with them, this endpoint meets them first, and then sends the message. Note that if you aren't in an existing conversation, you still must meet the criteria to meet them, meaning the user must currently be free for you to meet. You will receive an error message unless it is currently free for you to meet the user. You can use the users/{:IDS}/synergies endpoint to first determine if the user isn't already in a conversation with you and is free for you to meet and, if they aren't, how to pay to meet them. If you don't specify a message, it defaults to your custom introductory message defined in your settings.", "method": "post", "endpoint": "users/:ID/messages", "responses": [ { "uuid": "5358d3e1-7fad-4a1e-a8e6-bfe7e089325d", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0706c866-525d-4f30-923b-d27f72cbcc6f", "documentation": "Retrieve all key/value pairs attached to the current user that you have access to, so long as the user exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble. You will receive an error message unless either the current access token is bubbled, the user is an algorithmic match for you and you have not reached your quota of new introductions for the day, or you have paid to meet them. However, you can always use the /users/metadata/filters endpoint to filter across all users, including those that are unmatched, existing within the current access token's bubble based on preknown metadata key/value pairs.", "method": "get", "endpoint": "users/:ID/metadata", "responses": [ { "uuid": "4d7b366b-c85e-4629-9fb9-8daba4518ea8", "body": "{\n \"data\": [\n {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"content\": {\n \"key\": \"\",\n \"value\": \"\"\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"owner\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n },\n \"settings\": {\n \"privacy\": \"\"\n },\n \"status\": {\n \"last_updated_timestamp\": \"{{faker 'date.recent' 365}}\"\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ],\n \"pagination\": {\n \"limit\": {{faker 'number.int' max=99999}},\n \"offset\": {{faker 'number.int' max=99999}},\n \"total_records\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b4b2cdb-7187-48ad-b439-937afd66b528", "documentation": "Attach one-to-many key/value pairs of metadata to a user, so long as the user exists within the current access token's bubble. You can set one key at a time, with one or many values. A key is unique for each author/bubble combination. Attaching metadata with an existing key that was previously created by you, from within the same bubble, overwrites the key with the new value or set of values. The privacy setting allows you to specify who will have access to the metadata: Public metadata by anyone using an access token which grants them access to the user; Bubbled metadata by anyone using an access token existing within the current bubble; User metadata by you, so long as you are using an access token which grants you access to the user; Private metadata by you, so long as you are using an access token existing within the current bubble.", "method": "post", "endpoint": "users/:ID/metadata", "responses": [ { "uuid": "05edb18f-3b01-4265-bd9c-7241f904fb28", "body": "{\n \"data\": {},\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd7317f9-9879-4ccc-ac04-ac4efb34150e", "documentation": "Retrieve all key/value pairs attached to the current user that you have access to, so long as the user exists within the current access token's bubble. This includes all public metadata, bubbled metadata that was created by an access token existing within the current bubble, user metadata that was created by you, or private metadata created by you from an access token existing within the current bubble. You will receive an error message unless either the current access token is bubbled, the user is an algorithmic match for you and you have not reached your quota of new introductions for the day, or you have paid to meet them. However, you can always use the /users/metadata/filters endpoint to filter across all users, including those that are unmatched, existing within the current access token's bubble based on preknown metadata key/value pairs. Metadata will be grouped by key.", "method": "get", "endpoint": "users/:ID/metadata/collections", "responses": [ { "uuid": "7ffad4a5-26eb-44c8-a294-213076f0c188", "body": "{\n \"data\": {}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5e6f3dc-caae-46d0-830a-7b7529b08426", "documentation": "Retrieve the CV of a user who exists within the current access token's bubble. You will receive an error message unless either the current access token is bubbled, the user is an algorithmic match for you and you have not reached your quota of new introductions for the day, or you have paid to meet them. You can only record CV data to your own account. However, any app that you have OAuth'ed against can do so. By default, you will receive CV data that all apps have recorded for the user. Optionally, you can choose to only receive data that the current access token's bubble has recorded.", "method": "get", "endpoint": "users/:ID/positions", "responses": [ { "uuid": "86fc9128-18ad-42bd-aed4-ef355268e3aa", "body": "{\n \"data\": [\n {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"category\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"organization\": {\n \"industry\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"ticker\": \"\",\n \"type\": \"\",\n \"url\": \"\"\n },\n \"role\": {\n \"end_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"start_date\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\",\n \"summary\": \"\",\n \"title\": \"\"\n },\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5ff6fe1-e528-4269-ba82-3ca75239a990", "documentation": "Determine your match relationship with one or more users who exist within the current access token's bubble. Under some conditions, the price to meet the user will be $0. However, if this is not the case, the PayPal URL payment method will be provided along with the price to meet the user. The PayPal API can be leveraged to send payments programatically, provided the parameters passed in remain the same to ensure that the payment is correctly recorded. Once the payment has been recorded via PayPal IPN, the price to meet the user changes to $0. You can then call the users/{:ID}/meet endpoint to meet the user.", "method": "get", "endpoint": "users/:ID/synergies", "responses": [ { "uuid": "f6950de2-1b30-4ea4-b683-3e318730763f", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd47bd8d-16ec-48e1-aa0a-acac4b06b100", "documentation": "Skip, mute or unmute a user you've been matched with. Skipped matches are only presented as algorithmic matches after all other candidates have been exhausted. You cannot be matched with or meet muted users. You can only skip, mute or unmute users existing within the same bubble.", "method": "patch", "endpoint": "users/:ID/synergies", "responses": [ { "uuid": "1dcfd9d3-d2a7-4588-b663-835704cf7cd7", "body": "{\n \"data\": {\n \"relationship\": {\n \"muted\": {{faker 'datatype.boolean'}},\n \"skipped\": {{faker 'datatype.boolean'}}\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ef96af3c-d0bb-449f-8926-a83d91a5cc2e", "documentation": "Retrieve the currently OAuth'ed end-user, based on the access token being used, including private information and settings such as their email address.", "method": "get", "endpoint": "users/~", "responses": [ { "uuid": "b54b82ee-9dfc-47a6-96b9-6af8a78c0dfe", "body": "{\n \"data\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"location\": {\n \"city\": \"\",\n \"country\": {{faker 'number.int' max=99999}},\n \"ip_address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\"\n },\n \"matching\": {\n \"goals\": [\n \"\"\n ],\n \"interest_tags\": [\n \"\"\n ],\n \"location_importance\": \"\",\n \"targeted_industry\": \"\"\n },\n \"profile\": {\n \"first_name\": \"\",\n \"introduction\": \"\",\n \"last_name\": \"\"\n },\n \"settings\": {\n \"email\": \"\",\n \"email_verified\": {{faker 'datatype.boolean'}},\n \"notifications\": \"\",\n \"timezone\": {{faker 'number.int' max=99999}}\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a316a191-c89a-43c7-83b0-6c9ef88c1a2b", "documentation": "Update the OAuth'ed end user's account profile. At this time, for anti-spam reasons, restrictions preclude the ability to update email address and some other settings via the API.", "method": "patch", "endpoint": "users/~", "responses": [ { "uuid": "4f7dbe03-24cc-497b-b7a1-597cce296a15", "body": "{\n \"data\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"location\": {\n \"city\": \"\",\n \"country\": {{faker 'number.int' max=99999}},\n \"ip_address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"region\": \"\"\n },\n \"matching\": {\n \"goals\": [\n \"\"\n ],\n \"interest_tags\": [\n \"\"\n ],\n \"location_importance\": \"\",\n \"targeted_industry\": \"\"\n },\n \"profile\": {\n \"first_name\": \"\",\n \"introduction\": \"\",\n \"last_name\": \"\"\n },\n \"settings\": {\n \"email\": \"\",\n \"email_verified\": {{faker 'datatype.boolean'}},\n \"notifications\": \"\",\n \"timezone\": {{faker 'number.int' max=99999}}\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "168b0c0a-5000-4709-b006-930936d3800d", "documentation": "Fetch a listing of all webhooks owned by the current user/bubble combination.", "method": "get", "endpoint": "webhooks", "responses": [ { "uuid": "eb6b41d2-397b-4a2a-8703-59d1d08c79e0", "body": "{\n \"data\": [\n {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"event\": {\n \"action\": \"\"\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"object\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n },\n \"uri\": \"\",\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "defa2a38-880a-4970-8ccd-d188e6cf29dd", "documentation": "Register a new webhook for the current user/bubble combination. Specify an object_id to only be notified on an event related to that specific Conversation ID, Group ID, or User ID. Your access token must have access to the user being tracked, user you are in the conversation with, or user who created the group. You must be connected with a user in order to keep track of their online status. Alternatively, do not specify an object_id to be notified on all events that are related to conversations you're in, groups you're a member of, or users you are in conversations with. You may only have one webhook for each object_id/event. The webhook URI must reside on your own server. Webhooks do not expire when the access token used to create them expires. However, they will temporarily cease to function if the user who created them deauthorizes access to the application (effectively no longer existing within the bubble), unless/until the user reauthorizes the application using OAuth.", "method": "post", "endpoint": "webhooks", "responses": [ { "uuid": "75dcea24-e36d-4c07-91e8-a75421bf9078", "body": "{\n \"data\": {\n \"app\": {\n \"about\": {\n \"description\": \"\",\n \"name\": \"\",\n \"website\": {\n \"thumbshot\": \"\",\n \"url\": \"\"\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"legal\": {\n \"privacy_url\": \"\",\n \"tos_url\": \"\"\n }\n },\n \"event\": {\n \"action\": \"\"\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"object\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"type\": \"\"\n },\n \"uri\": \"\",\n \"user\": {\n \"business_card\": {\n \"company_name\": \"\",\n \"company_size\": \"\",\n \"headline\": \"\",\n \"industry\": \"\",\n \"interest_tags\": [\n \"\"\n ],\n \"job_position\": \"\",\n \"summary\": \"\",\n \"website\": {\n \"thumbshot_uri\": \"\",\n \"url\": \"\"\n }\n },\n \"community_persona\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"identity\": {\n \"avatar_uri\": \"\",\n \"badge\": \"\",\n \"profile_url\": \"\",\n \"username\": \"\"\n },\n \"location\": {\n \"free_form\": \"\"\n },\n \"personal\": {\n \"about_me\": \"\",\n \"birthday\": \"\",\n \"interests\": \"\",\n \"pc_specs\": \"\"\n },\n \"signature\": {\n \"parsed\": \"\",\n \"raw\": \"\"\n },\n \"stats\": {\n \"answered_count\": {{faker 'number.int' max=99999}},\n \"endorsements_count\": {{faker 'number.int' max=99999}},\n \"posts_count\": {{faker 'number.int' max=99999}},\n \"reputation_count\": {{faker 'number.int' max=99999}}\n }\n },\n \"id\": {{faker 'number.int' max=99999}},\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"usage\": {\n \"available_status\": {{faker 'datatype.boolean'}},\n \"joined_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"last_activity_timestamp\": \"{{faker 'date.recent' 365}}\",\n \"online_status\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "867a6884-297b-4d13-8406-86c1e966fe23", "documentation": "Delete a webhook that was previously registered by the current user/bubble combination.", "method": "delete", "endpoint": "webhooks/:ID", "responses": [ { "uuid": "c3954c82-0421-4dfa-a30d-76fb7736eb09", "body": "{\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Valid Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "081d4bd1-2186-4829-ba7a-cababa3c7ea8" }, { "type": "route", "uuid": "3717d3ac-1fb4-4ec3-ae6f-b7e6a2362ff7" }, { "type": "route", "uuid": "4c6dd4a8-1ead-4580-9c42-5986f63187b9" }, { "type": "route", "uuid": "c0efa0bd-7ad6-47a3-a6a5-6ec38b3c4699" }, { "type": "route", "uuid": "1f1bc4c2-1c59-44f7-9837-9223fec7cad9" }, { "type": "route", "uuid": "b70ed4d4-29d8-44d6-aa9f-d43c9017cbab" }, { "type": "route", "uuid": "a4880362-a2b5-4b17-a46f-4676f0486511" }, { "type": "route", "uuid": "7ff45181-4450-4d15-acb0-96b05da06adc" }, { "type": "route", "uuid": "46f6461a-d5fb-421c-8bc5-bf56010f69db" }, { "type": "route", "uuid": "4180546d-05cf-486a-83ca-292b63eba115" }, { "type": "route", "uuid": "769cf55b-7ee4-4112-bd45-3ba205a4e75f" }, { "type": "route", "uuid": "a9039e32-6b55-4fa9-bd70-23c10ef305f0" }, { "type": "route", "uuid": "176d2f8c-5b70-4017-a70d-236a82615984" }, { "type": "route", "uuid": "d43ea7bb-d4de-4c9c-b9ac-533863494446" }, { "type": "route", "uuid": "aebaef1e-b317-4bd1-a41f-93b62de409f7" }, { "type": "route", "uuid": "428aa99b-0a7f-4ca3-88e7-9c13c1a461a1" }, { "type": "route", "uuid": "b7e4acb8-07a4-45a4-ad8b-c31b206d3015" }, { "type": "route", "uuid": "66b50ca0-4367-499f-9d4b-65bb99968af0" }, { "type": "route", "uuid": "e81f2e15-e1dc-4974-a686-71f6e6b59339" }, { "type": "route", "uuid": "c67d4e60-f794-4d0a-8280-e9e0bb7fe668" }, { "type": "route", "uuid": "7baa3860-73d2-4aa0-a1d6-cf86351bbaef" }, { "type": "route", "uuid": "ec396fdf-98d3-4c11-850b-11ff99c62e9a" }, { "type": "route", "uuid": "4b2f2ec3-397b-4d61-9e1a-5abe63abeb26" }, { "type": "route", "uuid": "de19e54e-42bc-4bc8-a4ad-812047605090" }, { "type": "route", "uuid": "eb11475c-1819-478a-af57-97ef1a70e106" }, { "type": "route", "uuid": "32629b98-e8ed-4642-8523-14537fd04deb" }, { "type": "route", "uuid": "7a4177f8-db00-49a6-81d0-b08b4f1ac6f0" }, { "type": "route", "uuid": "148fe18d-0fe5-4e4c-a301-8cf05436be8f" }, { "type": "route", "uuid": "2d1173be-71f9-4cce-bd8e-74a1e31b5cbe" }, { "type": "route", "uuid": "163fcb3d-e969-4e1a-80ab-e368a03483fd" }, { "type": "route", "uuid": "6fbfa749-0dc3-495a-b332-6604a6a0fd75" }, { "type": "route", "uuid": "4b420cb7-f47d-4224-ba8d-c4bf0a298675" }, { "type": "route", "uuid": "2d2949fb-023b-4d13-a50b-10fc85c464fe" }, { "type": "route", "uuid": "aedcb0c4-fece-4f1e-a4d0-8295d46702cd" }, { "type": "route", "uuid": "5100cfac-2868-4c19-b72f-716c09270952" }, { "type": "route", "uuid": "89e95594-a7f7-40c2-a88d-19b9735e80b7" }, { "type": "route", "uuid": "df85042a-d244-4a0a-88a6-57a8d4d76974" }, { "type": "route", "uuid": "d8145937-232a-41b4-af85-55243e2886b3" }, { "type": "route", "uuid": "964efdc4-2ebd-481e-8362-bbd65a806731" }, { "type": "route", "uuid": "1d71180e-bd0b-423e-95b9-573d5bde1605" }, { "type": "route", "uuid": "032696b9-151a-4cd1-930e-2fef15128a1c" }, { "type": "route", "uuid": "028774e2-0c2e-42fc-9917-d59ef1025fa8" }, { "type": "route", "uuid": "9ab3ece3-a3d9-427d-bb26-c5e796d99c9e" }, { "type": "route", "uuid": "fd31e385-a877-475b-bac7-0ad9c509a8c4" }, { "type": "route", "uuid": "1d7a2599-5a3f-43ca-ba63-6e9e0dae3a35" }, { "type": "route", "uuid": "bdf70a81-2b06-4943-8f66-bd1563f014c5" }, { "type": "route", "uuid": "0ec863d2-6b0e-4834-8339-22a256ccb0fc" }, { "type": "route", "uuid": "5e83e22e-b629-4053-9243-2096d95bb693" }, { "type": "route", "uuid": "e9b2b848-eae1-4c63-92b7-8bcae60f5db1" }, { "type": "route", "uuid": "f9ee92a6-1bbd-48a3-b75c-0a58818a7eb3" }, { "type": "route", "uuid": "03baac99-55fc-4777-9ca1-19ae7c1485fa" }, { "type": "route", "uuid": "8943138f-227c-4e3f-8aa6-5334af50440d" }, { "type": "route", "uuid": "d5c9deb2-f0ec-4cab-bb34-5fbaa871923d" }, { "type": "route", "uuid": "78a37580-d02c-430a-b847-b243555f4a0e" }, { "type": "route", "uuid": "caaf2e88-fe84-43fb-aded-35a1312a044c" }, { "type": "route", "uuid": "44747c0b-8982-4c3b-a33a-c5fe10cd61a1" }, { "type": "route", "uuid": "0706c866-525d-4f30-923b-d27f72cbcc6f" }, { "type": "route", "uuid": "1b4b2cdb-7187-48ad-b439-937afd66b528" }, { "type": "route", "uuid": "fd7317f9-9879-4ccc-ac04-ac4efb34150e" }, { "type": "route", "uuid": "c5e6f3dc-caae-46d0-830a-7b7529b08426" }, { "type": "route", "uuid": "e5ff6fe1-e528-4269-ba82-3ca75239a990" }, { "type": "route", "uuid": "fd47bd8d-16ec-48e1-aa0a-acac4b06b100" }, { "type": "route", "uuid": "ef96af3c-d0bb-449f-8926-a83d91a5cc2e" }, { "type": "route", "uuid": "a316a191-c89a-43c7-83b0-6c9ef88c1a2b" }, { "type": "route", "uuid": "168b0c0a-5000-4709-b006-930936d3800d" }, { "type": "route", "uuid": "defa2a38-880a-4970-8ccd-d188e6cf29dd" }, { "type": "route", "uuid": "867a6884-297b-4d13-8406-86c1e966fe23" } ] }