{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"40f6ecaa-4336-97d2-59dd-0b62468696e1","name":"CONNECT RestAPI - V2","description":"CONNECT Extended Service is a REST based interface for interacting with your CONNECT communities. This documentation covers all details required to connect and interact with the various resources in a community.\n\n## Request Rate Limits and Acceptable Usage\n\nTo avoid the possibility of abuse complaints, balance your API requests with your datamart size. For example, when you make hundreds of requests per second to get list or contact details for 20,000 contacts in your datamart, it will look like abuse to our operations team.\n\n## Request and Response format\n\nCONNECT Extended Service accepts and returns JSON encoded data.\n\n## Supported HTTP methods\n\nCONNECT Extended Service supports the following HTTP methods when interacting with resources\n\n| HTTP Method | Description |\n| --- | --- |\n| POST | Create a resource |\n| GET | Retrieve a resource or collection of resources |\n| PUT | Update a resource |\n| DELETE | Delete a resource |\n\n> **Note:** Other methods _may_ be accepted but they are _not_ supported and should not be used as they may have unpredictable results \n  \n\n## Response Codes\n\nAll resource requests should return a valid HTTP status code. Included below are a few of the common statuses\n\n| Code | Description |\n| --- | --- |\n| 200 | Success, request completed |\n| 201 | Success, new resource created |\n| 204 | Success, no content to return (Delete) |\n| 400 | Bad Request, the request could not be parsed |\n| 401 | Unauthorized, invalid authentication token or credentials |\n| 404 | Not Found, resource does not exist |\n| 500 | Server error, something went wrong on our end |\n\n## Path\n\nThe API endpoint is the following [https://api.teksideconnect.com/v2](https://api.teksideconnect.com/v2)\n\nA username and password will be required, in this case :\n\nUsername = Account name\n\nPassword = Service Consumer Keys ( Provided by your account manager)\n\n# Authentication\n\nCONNECT Extended Service requires consuming applications authenticate requests with an **Authentication token** appended to the header of the HTTP request. The key value for the authentication token must be `Token`.\n\n## Getting an Authentication Token\n\nThe only endpoint in the CONNECT Extended Service that does not always require an authentication token is the [Me](#553fd593-1826-d492-5fa9-c90f3afb67bb) endpoint. The endpoint supports authentication by token and additionally through **HTTP Basic Authentication**.\n\nSuccessful authentication to [Me](#553fd593-1826-d492-5fa9-c90f3afb67bb) endpoint returns the current account's details, including current authentication token.\n\n> **Note:** Successful authentication with credentials generates a new authentication token and invalidates the old token. See **Revoking an Authentication Token** for more details. \n  \n\n### Authentication example\n\nThis is a sample request and response showing the process of authenticating with an **Authentication Token**\n\n##### Request to server\n\n```\nGET https://api.example.com/version/me HTTP/1.1\nHost: https://api.example.com/version\nConnection: keep-alive\nAccept: application/json\nCache-Control: no-cache\nToken: mmRbVglAo0CemN/OOiOshA\nContent-Type: application/json\n\n ```\n\n##### Response to client\n\n```\nHTTP/1.1 200 OK\nCache-Control: no-cache\nPragma: no-cache\nContent-Type: application/json; charset=utf-8\nExpires: -1\nContent-Length: 378\n{\n  \"data\": {\n    \"username\": \"CommunityUsername\",\n    \"token\": {\n      \"value\": \"mmRbVglAo0CemN/OOiOshA\",\n      \"expiryDate\": \"2015-03-21T11:29:22.26Z\",\n      \"issuedDate\": \"2015-01-12T11:46:42.047Z\"\n    }\n  },\n  \"links\": [\n    {\n      \"self\": \"https://api.example.com/version/me\"\n    },\n    {\n      \"community\": \"https://api.example.com/version/community\"\n    }\n  ]\n}\n\n ```\n\n> **Info:** For more information about this endpoint please see the [Me](#account-me) section of this document. \n  \n\n### Revoking an Authentication Token\n\nThere may be a time where the current authentication token needs be be invalidated and a new one generated. This can be accomplished by simply re-authenticating with credentials. This process will generate a new authentication token and invalidate the old one.\n\n# Uniform response format\n\nThe CONNECT uses a single format for all of its standard responses. Responses are expressed in as JSON objects and come in 1 of 2 variations.\n\nBoth variations contain the properties `data` and `links`. The `data` property can either be an **object** or a **collection** depending whether the response is for single or collection resources respectively.\n\nThe `links` property contains a collection of links related to the current response resource. Links are structured as a key-value pair with a the key representing the related entry and the value being the url for that resource. These links can allow consuming applications to navigate to related resources without the need to hard code urls.\n\nFor each successful request that returns a resource, a link entry named `self` will be included in the `links` collection. The `self` entry will always contain the url of the request that generated the current response.\n\n> **Info:** See the relevant sections on **Single** and **Collection** resources for more details on the `links` property values. \n  \n\n## Single resource\n\nResponses that represent a single resource will return a response that contains the `data` and `links` properties.\n\nThe `data` property will be an object or non-collection type that represents the requested resource.  \nThe `links` section will typically return a list of key-value entries that point to other resources that are associated to the requested object.\n\n```\n{\n  \"data\": \"Hello World!!\",\n  \"links\": [\n    { \"self\": \"https://api.example.com/version/users/bob/messages/1\" },\n    { \"user\": \"https://api.example.com/version/users/bob\" }\n  ]\n}\n\n ```\n\n## Collection resource\n\nResponses that represent a collection of resources will return a response that contains the `data`, `count` and `links` properties.\n\nThe `data` property will be an object or non-collection type that represents the requested resource.\n\nThe `counts` property gives the total number of entries for the requested resource regardless of how many are returned by the request. This is helpful when implementing paging for a given resource.\n\nThe `links` section will typically return a list of key-value entries that point to other resources that are associated to the requested object. Collections responses will use the `id` values for the returned resources in the `links` collection so that consuming applications can easily link to the individual resources easily.\n\n```\n{\n  \"data\": [\n    { \"id\": 1, \"Hello World!!\" },\n    { \"id\": 2, \"How are you?\" },\n    { \"id\": 3, \"APIs are great fun\" },\n    { \"id\": 4, \"Waffles are the best\" }\n  ],\n  \"count\": 4,\n  \"links\": [\n    { \"self\": \"https://api.example.com/version/users/bob/messages\" },\n    { \"1\": \"https://api.example.com/version/users/bob/messages/1\" },\n    { \"2\": \"https://api.example.com/version/users/bob/messages/2\" },\n    { \"3\": \"https://api.example.com/version/users/bob/messages/3\" },\n    { \"4\": \"https://api.example.com/version/users/bob/messages/4\" },\n    { \"user\": \"https://api.example.com/version/users/bob\" }\n  ]\n}\n\n ```\n\n# Document conventions\n\nThroughout the rest of this document placeholder values have been marked with a set of double curly-braces (`{{` `}}`) surrounding a brief description of the value. Please replace these placeholders with appropriate values based on your applications.\n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"97199","collectionId":"40f6ecaa-4336-97d2-59dd-0b62468696e1","publishedId":"6Z5PXA6","public":true,"publicUrl":"https://docs.api.teksideconnect.com","privateUrl":"https://go.postman.co/documentation/97199-40f6ecaa-4336-97d2-59dd-0b62468696e1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2EA3F2"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-03-12T20:45:57.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://teksideconnect.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.api.teksideconnect.com/view/metadata/6Z5PXA6"}