List Projects
  • 14 Aug 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

List Projects

  • Dark
    Light
  • PDF

List Projects

Method for getting a list of Projects of a Company

postman Download our collection of Postman queries to see more examples of Corezoid API v2.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{TIMESTAMP}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "list",
            "obj": "projects",
            "sort": {{SORT_}}
            "company_id": {{COMPANY_ID}}
        }
    ]
}
Parameter Type Required Description Possible value
ops JSON Object + The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations * The number is user-limited by RPS limit.
type string + A request type list
obj string + An object of request projects
sort string - Name of field to sort result title
company_id string + An ID of an Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "obj": "projects",
            "proc": "ok",
            "list": [
                {
                    "is_shared": true,
                    "favorite": false,
                    "privs": [
                        {
                            "type": "create",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "view",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "modify",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "delete",
                            "list_obj": [
                                "all"
                            ]
                        }
                    ],
                    "childs": 4,
                    "size": 4,
                    "is_owner": true,
                    "owner_id": 6469,
                    "owner_name": "Api_super",
                    "owner_login": "5c0fab2a56167c2fe4001321",
                    "obj_id": 155216,
                    "obj_type": "project",
                    "create_time": 1625813544,
                    "change_time": 1625813544,
                    "title": "Pod",
                    "description": "",
                    "company_id": "i460234064",
                    "short_name": "pod",
                    "project_id": 155216,
                    "owner_group_id": 16565
                },
                {
                    "is_shared": true,
                    "favorite": false,
                    "privs": [
                        {
                            "type": "create",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "view",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "modify",
                            "list_obj": [
                                "all"
                            ]
                        },
                        {
                            "type": "delete",
                            "list_obj": [
                                "all"
                            ]
                        }
                    ],
                    "childs": 4,
                    "size": 4,
                    "is_owner": true,
                    "owner_id": 6469,
                    "owner_name": "Api_super",
                    "owner_login": "5c0fab2a56167c2fe4001321",
                    "obj_id": 155221,
                    "obj_type": "project",
                    "create_time": 1625813876,
                    "change_time": 1625813876,
                    "title": "Opd",
                    "description": "",
                    "company_id": "i460234064",
                    "short_name": "opd",
                    "project_id": 155221,
                    "owner_group_id": 16565
                }
            ]
        }
    ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops array The list of request results
id string Request ID empty
proc string The processing status of a specific operation ok, error
obj string An object of request projects
list array The list of Users and their rights to requested object An array of projects
list[].is_shared boolean Flag of shared Project true / false
list[].favorite boolean Flag of adding Project to favorites true / false
list[].privs array An array of user rights settings for a shared object view, create, modify, delete
list[].childs number Number of Project Stages
list[].size number Size of Project Stages
list[].is_owner boolean Flag of the current User's ownership of a Project true / false
list[].owner_id number Project owner ID
list[].owner_name string Project owner displayed name
list[].owner_login string Project owner login
list[].obj_id number Project ID
list[].obj_type string An object type project
list[].create_time number Time of a Project creation, timestamp
list[].change_time number Time of a Project last change, timestamp
list[].title string Project name
list[].description string Project description
list[].company_id string ID of a Company where a Project is stored
list[].short_name string Project short name
list[].project_id number Project ID
list[].owner_group_id number Project owner group ID