API Overview

Introduction

Make the most out of Cotalker's potential for your automation processes using its API tools.

Everything available in Cotalker's GUI is accessible through API requests. This permits developers to add extra layers of automatization and the ability to integrate other systems with Cotalker. Here are some examples of what you can do with Cotalker's API tools:

• easily upload large amounts of data
• scale and automate the work of admins
• integrate ERP, CRM, Satellites, and IoT
• externally automate processes
• gather data from different endpoints
• configure user, group, and other platform settings
• quickly modify user permissions and access roles
• configure workflows and tasks
• manage the data in your collections
• and much more!

Learn more about the different endpoints and start taking your company's automation process to the next level!

Getting Started

Using the web API through a script or integration is as simple as calling an endpoint, e.g., getting all users:
GET https://www.cotalker.com/api/v2/users.

All endpoints MUST be called with the corresponding authorization or access-token.

URLs

URLs are used based on the endpoint that is called. The documentation for each endpoint indicates the appropriate URL.

Available URLs:

• https://www.cotalker.com/api/v1
• https://www.cotalker.com/api/v2
• https://www.cotalker.com/api/v3

demo users

If you're using Cotalker through a free-trial demo, use the following URL paths:

• https://demo.cotalker.com/api/v1
• https://demo.cotalker.com/api/v2
• https://demo.cotalker.com/api/v3

Endpoints

In this documentation, you can find basic REST API requests with samples and references to their data models. For a complete schematic guide to our APIs, please consult our API documentation in Swagger.

Here's a list of the endpoints we cover in this documentation:

Endpoint	Description	Data Model(s)
/auth/local	authentication token	N/A
/companies	company configuration and settings	COTCompany
/users	users in your company, both humans and bots	COTUser
/accessroles	set of permissions granted to users	COTAccessRole
/jobtitles	job titles can group users and give them special attributes	COTJobTitle
/groups	groups hold together tasks and channels or act as links to URLs	COTGroup
/channels	workspace channels where users can view task information, answer surveys, or chat with other users associated with the channel	COTChannel
/propertyTypes	property types (collections) are like tables that can store all kinds of data	COTPropertyType
/properties	properties (elements) make up the property types and can be used to act as assets or even states	COTProperty
/messages	messages correspond to chat messages users send to each in channels, responses submitted in a survey, or system-generated messages	COTMessage, COTMessageContentType
/media/file	upload and retrieve files
/surveys	surveys gather different types of input from users	COTSurvey
/surveychats	each survey chat holds questions that correspond to a surveycomponent	COTSurveyChat
/questions	questions form part of survey components	COTQuestion, COTQuestionContentType, COTQuestionExec
/answers	answers represent the input submitted through surveys	COTAnswer, COTAnswerData
/tasks	this endpoint holds together everything related to tasks: tasks, task groups, state machines, states, and SLAs	COTTask, COTTaskGroup, COTSMStateMachine, COTSMState, COTSMSLA
/bots	bots carry out diverse programmable routines	COTBot, COTParametrizedBot
/schedules	schedules are automated scheduled routines	COTSchedule, COTParametrizedBot
/pbscripts	corresponds to saved routine stages that can be later incorporated to any routine	COTPBScript, COTParametrizedBot

Interactions

graph LR; U[Users] --> C U --> A U --> P G[Groups] --> C C[Channels] --> P C --> B P[Databases] M[Messages] --> C S[Surveys] --> P S --> A A[Access Roles] X[State Machine] X --> G T[Tasks] --> X T --> C R[Scheduler] Z[Company] B[Bots] W[Answer] S --> W U --> W C --> W