Cubicl Docs
  • What is Cubicl?
  • Starting
    • Get to Know Cubicl
    • Frequently Asked Questions (FAQ)
    • First Steps in Cubicl
      • How Do I Track My Tasks?
      • How Do I Create a Project Plan?
      • How Do I Communicate with My Team?
      • How Do I Stay Informed About Progress?
      • How to Create a Task?
    • Cubicl Mobile Application
  • Task and Project Management
    • Projects
      • Tasks Page
      • Files Page
      • Gantt Chart
        • Features Of Gantt Chart
        • Tips for Planning a Project
      • Timeline Chart
      • Calendar
      • Reports
      • Project Settings
    • Create Tasks
      • Task Details Page
      • Other Settings on Tasks
    • Chat
    • E-mail to Task
    • Workflows
    • Automation
    • Integrations
    • Custom Actions
    • Forms
    • Search Across
  • CRM
    • Clients
    • Deals
    • Client Portal
    • Bookkeeping
  • User Pages
    • Home Page
    • My Calendar
    • Sticky Notes
    • Account, E-mail and Notification Settings
    • Account Security
  • Organization and User Settings
    • Organization Settings
    • Subscription and Payment
    • User Permissions
    • Time-Offs
  • 🖥️API Integration
    • Introduction
    • Users
    • Projects
    • Tasks
    • Files
    • Clients
    • Chat
    • Bookkeeping
    • Webhooks
Powered by GitBook
On this page
  • Endpoints
  • Get All Users
  • Get Users By Id
  • Get Me
  • Data

Was this helpful?

  1. API Integration

Users

Endpoints

Get All Users

GET https://cubicl.io/api/v1/organization/users

Gets all users who are currently a member of the organization.

Tasks and other records may refer to users who are removed from the organization or who are client portal users. Use Get Users By Id endpoint to get their details.

User[]

Get Users By Id

GET https://cubicl.io/api/v1/users

Returns multiple users whose ids are given.

Cubicl keeps data created by (sent chat messages, task comments, etc.) and related (tasks assigned, etc.) to users even after they are removed from the organization account. In order to access their details, you can use this endpoint.

User ids in the records can belong to not only Cubicl users but also Client Portal users or email senders. This endpoint will return them too.

The email address is not included in the response.

Query Parameters

Name
Type
Description

ids*

string

Comma-separated list of ids

{
    _id : string;
    firstname: string;
    lastname: string;
    profile: string; // URL for profile photo
}[]

Get Me

GET https://cubicl.io/api/v1/app/me

Returns information related to the currently authenticated user.

{
    _id : string;
    firstname: string;
    lastname: string;
    profile: string; // URL for profile photo
    jobTitle: string | null;
    language: string;
    localization: {
        dateFormat: string;
        timeFormat: string;
        timezone: number;
    };
    org: {
        name: string;
        countryCode: string;
        // Admin user ids
        admins: string[];
        isAdmin: boolean;
    }
}

Data

Users

type User = {
    _id : string;
    firstname: string;
    lastname: string;
    email: string;
    profile: string; // URL for profile photo
}

PreviousIntroductionNextProjects

Last updated 1 year ago

Was this helpful?

🖥️