projects_list: List projects

Description

List projects

Usage

projects_list(
  permission = NULL,
  auto_share = NULL,
  author = NULL,
  hidden = NULL,
  archived = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Value

An array containing the following fields:

id

integer, The ID for this project.

author

list, A list containing the following elements:

id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.

name

string, The name of this project.

description

string, A description of the project.

users

array, An array containing the following fields:

id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.

autoShare

boolean,

createdAt

string,

updatedAt

string,

archived

string, The archival status of the requested item(s).

Arguments

permission: string optional. A permissions string, one of "read", "write", or "manage". Lists only projects for which the current user has that permission.
auto_share: boolean optional. Used to filter projects based on whether the project is autoshare enabled or not.
author: string optional. If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.
hidden: boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.
archived: string optional. The archival status of the requested item(s).
limit: integer optional. Number of results to return. Defaults to 20. Maximum allowed is 1000.
page_num: integer optional. Page number of the results to return. Defaults to the first page, 1.
order: string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.
order_dir: string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.