Projects.list

Returns all defined Projects

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Projects are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of Projects

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Project) {37}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

project_type

string <uri>

required

Relation to ProjectType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProjectType' object for properties.

unit

string <uri>

required

Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

end_date

string <date>

required

Date information.

Example:

2019-01-01

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

revenue_goal

object

required

Monetary value in a foreign currency.

documents

array[string <uri>]

optional

Relations to CloudObjects.

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

primary_contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

tags

array[string <uri>]

optional

Relations to Tags.

static_profiles

array[string <uri>]

optional

Relations to Profiles.

objectives

array[string <uri>]

optional

is_favorite

boolean

required

Example:

false

status

enum<integer>

required

Integer enum value: 1 - NotStarted, 2 - InProgress, 4 - Completed

Allowed values:

124

Example:

completion_rate

number <double>

optional

Example:

4.32

activities_total

number <double>

optional

Example:

4.32

activities_completed

number <double>

optional

Example:

4.32

formatted_name

string

required

Example:

string

modified_by_user

string <date-time>

optional

Example:

2019-01-01T00:00:00

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "account": "http://example.com",
      "currency_exchange_rates_list": "http://example.com",
      "owner": "http://example.com",
      "project_type": "http://example.com",
      "unit": "http://example.com",
      "account_id": "01234567-abcd-dcba-ffff-000000000000",
      "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
      "description": "string",
      "end_date": "2019-01-01",
      "name": "string",
      "owner_id": "01234567-abcd-dcba-ffff-000000000000",
      "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "share_mode": 0,
      "start_date": "2019-01-01",
      "unit_id": "01234567-abcd-dcba-ffff-000000000000",
      "revision": 1,
      "revenue_goal": {
        "base_value": "4.32",
        "currency_id": "01234567-abcd-dcba-ffff-000000000000",
        "value_foreign": "4.32"
      },
      "documents": [
        "http://example.com"
      ],
      "sharing_units": [
        "http://example.com"
      ],
      "sharing_clients": [
        "http://example.com"
      ],
      "primary_contact": "http://example.com",
      "contact_relations": [
        "http://example.com"
      ],
      "tags": [
        "http://example.com"
      ],
      "static_profiles": [
        "http://example.com"
      ],
      "objectives": [
        "http://example.com"
      ],
      "is_favorite": false,
      "status": 1,
      "completion_rate": "4.32",
      "activities_total": "4.32",
      "activities_completed": "4.32",
      "formatted_name": "string",
      "modified_by_user": "2019-01-01T00:00:00"
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

Request

Request samples

Responses