Project Resource - Overview

A Project is the key organizational principle of a credit portfolio because it groups together related "Credits", which are the core object of the system. Projects can contain one or more (or none) Credits. View the Credits Resource for more information.

Methods

The API supports the following methods for Project resources:

• List:
  • Returns a list of Projects that match the API request parameters. For example, you can retrieve all Projects that the API Credentials have access to, or you can filter the list of Projects based on certain parameters. Learn More

Resource Representation

The following JSON structure shows the format of a Project resource:

{
    "id": integer,
    "created_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "updated_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "status": string,
    "account": {
       "id": integer,
       "title": string,  
    },
    "created_by": {
       "id": integer,
       "first_name": string,
       "last_name": string,
       "email": string,
    },
    "title": string,   
    "description": string,   
    "date_project_start": string (format YYYY-MM-DD),
    "date_project_end": string (format YYYY-MM-DD),
    "credits": {
        "item_count": integer
    },
    "custom_data_points":[
        {
            "id": integer,
            "name": string,
            "type": string,
            "value": string,
        }
    ],
}

Resource Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
id	integer	The ID of the project.
created_at	string	The date and time that the Project was created. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
updated_at	string	The date and time that the Project was last updated. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
status	string	The phase (or status) of the Project. The values of this are configured by the customer.
account	object	Contains information about the Incentify account this Project is attached to.
account.id	integer	The ID of the Incentify account that owns this Project.
account.title	string	The name of the Incentify account that owns this Project.
created_by	object	Contains information about the user that loaded this Project.
created_by.id	integer	The ID of the user that loaded this Project.
created_by.first_name	string	The first name of the user who loaded this Project.
created_by.last_name	string	The last name of the user who loaded this Project.
created_by.email	string	The email address of the user who loaded this Project.
title	string	The name of the Project.
description	string	A brief description of the Project.
date_project_start	date	Date the project will/did start. The date format is yyyy-mm-dd.
date_project_end	date	Date the project will/did end. The date format is yyyy-mm-dd.
credits	object	Contains summary information of Credits attached (see the Credits Resource).
credits.item_count	integer	The number of Credits attached to the Project (if greater than zero, you can then make a request to the Credits Resource with the Project ID to get a list of those Credits.
custom_data_points[]	list	Contains a list of custom data points (ie; not system default fields). Therefore, the format of each is included in the data. "id" is the unique ID of the custom data point. "name" is the visual name of the field. "type" is the format (ie; string, date, etc). "value" is the value entered for that custom data point.