Projects
get
https://api.tiny.plus
/v2/projects/{{id}}
Get a Project

Example Usage

jQuery
PHP
1
var settings = {
2
"url": "https://api.tiny.plus/v2/projects/{{id}}",
3
"method": "GET",
4
"headers": {
5
"Authorization": "{{user_access_token}}"
6
}
7
};
8
9
$.ajax(settings).done(function (response) {
10
console.log(response);
11
});
Copied!
1
<?php
2
3
$curl = curl_init();
4
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => "https://api.tiny.plus/v2/projects/{{id}}",
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => "",
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => false,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => "GET",
14
CURLOPT_HTTPHEADER => array(
15
"Authorization: {{user_access_token}}"
16
),
17
));
18
19
$response = curl_exec($curl);
20
$err = curl_error($curl);
21
22
curl_close($curl);
23
24
if ($err) {
25
echo "cURL Error #:" . $err;
26
} else {
27
echo $response;
28
} ?>
Copied!
get
https://api.tiny.plus
/v2/projects
List Projects

Example Usage

jQuery
PHP
1
var settings = {
2
"url": "https://api.tiny.plus/v2/projects?me&return_format=array",
3
"method": "GET",
4
"headers": {
5
"Authorization": "{{user_access_token}}"
6
}
7
};
8
9
$.ajax(settings).done(function (response) {
10
console.log(response);
11
});
Copied!
1
<?php
2
3
$curl = curl_init();
4
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => "https://api.tiny.plus/v2/projects?me&return_format=array",
7
CURLOPT_RETURNTRANSFER => true,
8
CURLOPT_ENCODING => "",
9
CURLOPT_MAXREDIRS => 10,
10
CURLOPT_TIMEOUT => 0,
11
CURLOPT_FOLLOWLOCATION => false,
12
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
CURLOPT_CUSTOMREQUEST => "GET",
14
CURLOPT_HTTPHEADER => array(
15
"Authorization: {{user_access_token}}"
16
),
17
));
18
19
$response = curl_exec($curl);
20
$err = curl_error($curl);
21
22
curl_close($curl);
23
24
if ($err) {
25
echo "cURL Error #:" . $err;
26
} else {
27
echo $response;
28
} ?>
Copied!
post
https://api.tiny.plus
/v2/projects
Create a Project
patch
https://api.tiny.plus
/v2/projects/{{id}}
Update a Project
delete
https://api.tiny.plus
/v2/projects/{{id}}
Delete a Project

Projects Field Reference

Field
Type
Details
Permission
id
Number
Unique record identifier.
Read-only
name
String (up to 200 characters).
REQUIRED.
Project Name.
Full
description
String
Description.
Full
created_date
String (Y-m-d h:i:s)
Date record was first created.
Read-only
modified_date
String (Y-m-d h:i:s)
Date record was last modified.
Read-only
created_user
Number
ID of user who made the record.
Read-only
modified_user
Number
ID of user who last edited the record.
Read-only
assigned_user
Number
ID of assigned user.
Full
is_synced
Boolean
Whether the record has been synced from another source.
Full
sync_origin
String (up to 50 characters)
A simple string that you supply to let tiny+ users know where the record is synced from.
Full
remote_id
String (up to 200 characters)
A remote identifier for this record.
Full
record_status
String
The status of the Project. Values you can use: proposal, won, active, completed, lost, cancelled.
When adding or editing a project, if your account is using additional phases for project status, you must pass the correct phase ID here in place of the possible values.
Full
record_url
String
The fully qualified URI of the record.
Read-only
project_number
String
The user-friendly identifier for this project.
Full
primary_company_id
String | ID
When reading this field, it will display the ID of the primary related company.
When adding or updating, you can provide EITHER an ID, or a string with the company name. If you provide a string, a company will be created with that name. If a company with that exact name already exists, it will be matched to that company.
Full
year_start
Number
A YYYY date. eg. 2019
Full
project_value
Currency
The value of the project, to 2 decimal places. Do not include currency signs when adding or updating. eg provide
20000.00 for $20,000.
Full
fee_value
Currency
The fee value, to 2 decimal places. Do not include currency signs when adding or updating. eg provide
20000.00 for $20,000.
Full
folder_location
String
A field to set a local or network folder location, for example to a network drive in a corporate network.
Full
testimonial
String
A client testimonial provided by the user about this project.
Full
website_link
URL
An external URL that hosts information about this Project.
Full
project_address
String
A project's physical address.
Full
close_date
String (YYYY-MM-DD hh:mm:ss)
The datetime stamp that the project was marked as won, lost or cancelled.
Read-only
expected_start_date
String (YYYY-MM-DD)
A user provided date for when the project is expected to commence.
Full
expected_duration
String (ISO 8601 Duration-only format)
A user provided period identifying the expected length of time this project will run for.
(eg. P4M for 4 months, P14D for 2 weeks, P40D for 40 days)
Full
expected_finish_date
String (YYYY-MM-DD)
A user provided date for when the project is expected to conclude.
Full
probability
Number (0-100)
The percentage chance the project will close.
Full
completed_date
String (YYYY-MM-DD hh:mm:ss)
The datetime stamp the project was marked as completed.
Read-only
created_date_daysago
Number
How long since the project was created, in days.
Read-only
start_date
String (YYYY-MM-DD)
The recorded date the project began.
Full
end_date
String (YYYY-MM-DD)
The recorded date the project finished.
Full
photographer
Text
The photographer used on the project.
Full
awards
Text
The awards given to the project.
Full
extra_notes
Text
An extra notes field.
Full
referee
Text
The project referee.
Full
external_url
String or JSON object
A link to this project in another system. Helpful when used with sync_origin. This can hold a simple string URL. However some records may exist in multiple systems, so we recommend you namespace your external URL by providing a JSON object like so:
{ "MyApp": "https://app.example.com/135" }
This will make sure that other integrations will not interfere with your URL.
Full
Last modified 1yr ago