Skip to main content

Retrieving data

Load data from a Comind workspace app using:

https://api.comindwork.com/api/w/${workspace}/a/${app}/tickets/list

Omit the workspace/app pair to search across all available data (all workspaces and apps).

Use filter expressions, record limits, and field lists to narrow the results.

Permission to access data​

The access rights of the authenticated user apply to all queries. The query may return empty results if the user does not have access to a given workspace, app, or record.

Fields the user cannot access are excluded from the response.

Sample code​

Retrieve list of users

curl --request POST ^
--url "https://api.comindwork.com/api/w/METAMETA/a/USER/tickets/list" ^
--json {limitRecords:100} ^
--header "Authorization:CMW_AUTH_CODE YOUR-AUTH-CODE-GOES-HERE"
async function getAllUsers() {
  const workspaceAlias = "METAMETA";
  const appAlias = "USER";
  const apiEndpoint = `w/${workspaceAlias}/a/${appAlias}/tickets/list`;
  const allUsers = await comind.records.retrieve(apiEndpoint, {
    limitRecords: 100,
  });
  console.warn(`Found users: ${allUsers.length}`);
  return allUsers;
}

Retrieve list of tasks (records in Task app) in the Helpdesk workspace, filter by normal-priority unfinished tasks

curl --request POST ^
--url "https://api.comindwork.com/api/w/HELPDESK/a/TASK/tickets/list" ^
--json "{limitRecords:1,listOfFields:'priority,number',rlx:'priority=\"normal\" and state!=\"resolved\"'}" ^
--header "Authorization:CMW_AUTH_CODE YOUR-AUTH-CODE-GOES-HERE"

Supported parameters​

  • listOfFields - by default only system-fields included, use "ALL" to get all records' fields, or specify exact list of fields
  • sortBy - sorting - for example "sortBy=creation_date desc"
  • limitRecords - limiting number of returned values - e.g. 10
  • skipRecords - number of items to skip - e.g. 100, used with limitRecords
  • rlx - possibility to filter data with query - e.g. 'priority="normal" and state!="resolved"'