API examples
Fetch examples
Sample GET requests for filtering, expanding associations and selecting fields.
Fetching tasks based on project filters
Fetch all tasks of a project having id 1234.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"project.id":"1234"}' \
'https://app.celoxis.com/psa/api/v2/tasks'Response
{
data: [
{
id: "123456",
url: "https://app.celoxis.com/psa/tasks/123456",
name: "api time entry task",
description: "",
hierarchy: "",
topmostTask: "api time entry task",
sN: "4",
wbs: "4",
color: "",
plannedStart: "2019-08-05",
plannedStartWeek: "32-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
plannedFinish: "2019-08-05",
plannedFinishWeek: "32-2019",
plannedFinishMonth: "2019-08",
plannedFinishQuarter: "Q3 2019",
plannedFinishYear: "2019",
plannedFinishFiscalYear: "2019",
actualStart: "",
actualStartWeek: "",
actualStartMonth: "",
actualStartQuarter: "",
actualStartYear: "",
actualStartFiscalYear: "",
actualFinish: "",
actualFinishWeek: "",
actualFinishMonth: "",
actualFinishQuarter: "",
actualFinishYear: "",
actualFinishFiscalYear: "",
projectedStart: "",
projectedStartWeek: "",
projectedStartMonth: "",
projectedStartQuarter: "",
projectedStartYear: "",
projectedStartFiscalYear: "",
projectedFinish: "",
projectedFinishWeek: "",
projectedFinishMonth: "",
projectedFinishQuarter: "",
projectedFinishYear: "",
projectedFinishFiscalYear: "",
projectedCost: "0",
actualRevenue: "0",
plannedEffort: "0",
scheduleType: "FIXED_WORK",
duration: "1d",
predecessors: "",
successors: "",
constraintType: "ASAP",
constraintDate: "",
priority: "NORMAL",
actualPercentComplete: "0",
remainingEffort: "0",
created: "2019-09-04",
lastModified: "2019-09-04",
lastUpdate: "",
allUpdates: "",
lastUpdated: "2019-09-04",
resources: "",
scheduleHealth: "Not Active",
budgetHealth: "Not Active",
plannedRevenue: "0",
plannedLaborRevenue: "0",
budget: "0",
fixedPrice: "0",
billingType: "FIXED_PRICE",
plannedCost: "0",
actualCost: "0",
actualLaborHours: "0",
myEstHours: "0",
myActHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
plannedFixedCost: "0",
plannedNonLaborCost: "0",
plannedLaborCost: "0",
actualNonBillableLaborAmount: "0",
actualBillableLaborAmount: "0",
actualBillableExpense: "0",
actualNonBillableExpense: "0",
actualLaborCost: "0",
actualNonLaborCost: "0",
actualFixedCost: "0",
projectedLaborHours: "0",
attachments: "",
milestone: "No",
isManuallyScheduled: "No",
isTimeAllowed: "Yes",
critical: "No",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "0",
baselineStart: "",
baselineStartVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "",
showInTimeline: "No",
externalKey: "",
custom_kanban_state: "Backlog",
custom_single_select: "",
custom_text: "",
project: "https://app.celoxis.com/psa//api/v2/tasks/123456/project",
parent: "https://app.celoxis.com/psa//api/v2/tasks/123456/parent",
assignments: "https://app.celoxis.com/psa//api/v2/tasks/123456/assignments",
},
{
id: "123457",
url: "https://app.celoxis.com/psa/tasks/123457",
name: "API Task",
description: "",
hierarchy: "",
topmostTask: "API Task",
sN: "5",
wbs: "5",
color: "",
plannedStart: "2019-08-05",
plannedStartWeek: "32-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
plannedFinish: "2019-08-05",
plannedFinishWeek: "32-2019",
plannedFinishMonth: "2019-08",
plannedFinishQuarter: "Q3 2019",
plannedFinishYear: "2019",
plannedFinishFiscalYear: "2019",
actualStart: "2019-09-04",
actualStartWeek: "36-2019",
actualStartMonth: "2019-09",
actualStartQuarter: "Q3 2019",
actualStartYear: "2019",
actualStartFiscalYear: "2019",
actualFinish: "",
actualFinishWeek: "",
actualFinishMonth: "",
actualFinishQuarter: "",
actualFinishYear: "",
actualFinishFiscalYear: "",
projectedStart: "",
projectedStartWeek: "",
projectedStartMonth: "",
projectedStartQuarter: "",
projectedStartYear: "",
projectedStartFiscalYear: "",
projectedFinish: "",
projectedFinishWeek: "",
projectedFinishMonth: "",
projectedFinishQuarter: "",
projectedFinishYear: "",
projectedFinishFiscalYear: "",
projectedCost: "0",
actualRevenue: "0",
plannedEffort: "0",
scheduleType: "FIXED_WORK",
duration: "1d",
predecessors: "",
successors: "",
constraintType: "ASAP",
constraintDate: "",
priority: "NORMAL",
actualPercentComplete: "20",
remainingEffort: "0",
created: "2019-09-04",
lastModified: "2019-09-04",
lastUpdate: "Peter Parker \u2022 Yesterday\r\ntask update created via api",
allUpdates: "Peter Parker \u2022 Yesterday\r\ntask update created via api",
lastUpdated: "2019-09-04",
resources: "",
scheduleHealth: "Not Active",
budgetHealth: "Not Active",
plannedRevenue: "0",
plannedLaborRevenue: "0",
budget: "0",
fixedPrice: "0",
billingType: "FIXED_PRICE",
plannedCost: "0",
actualCost: "0",
actualLaborHours: "0",
myEstHours: "0",
myActHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
plannedFixedCost: "0",
plannedNonLaborCost: "0",
plannedLaborCost: "0",
actualNonBillableLaborAmount: "0",
actualBillableLaborAmount: "0",
actualBillableExpense: "0",
actualNonBillableExpense: "0",
actualLaborCost: "0",
actualNonLaborCost: "0",
actualFixedCost: "0",
projectedLaborHours: "0",
attachments: "",
milestone: "No",
isManuallyScheduled: "No",
isTimeAllowed: "Yes",
critical: "No",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "0",
baselineStart: "",
baselineStartVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "",
showInTimeline: "No",
externalKey: "",
custom_kanban_state: "Backlog",
custom_single_select: "",
custom_text: "",
project: "https://app.celoxis.com/psa//api/v2/tasks/123457/project",
parent: "https://app.celoxis.com/psa//api/v2/tasks/123457/parent",
assignments: "https://app.celoxis.com/psa//api/v2/tasks/123457/assignments",
},
],
totalRecords: 2,
}Filter by a Custom Field
Fetch all projects having custom field Country, whose formula key is country, equal to America.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"custom_country":"America"}' \
'https://app.celoxis.com/psa/api/v2/projects'Response
{
data: [
{
id: "1234",
url: "https://app.celoxis.com/psa/projects/1234",
name: "API Project",
description: "Description related to the project",
code: "celoxis1",
created: "2019-08-13",
lastModified: "2019-09-04",
plannedStart: "2019-08-05",
plannedStartWeek: "32-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "",
deadlineWeek: "",
deadlineMonth: "",
deadlineQuarter: "",
deadlineYear: "",
deadlineFiscalYear: "",
plannedFinish: "2019-09-16",
projectedFinish: "2019-09-10",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "0",
state: "Draft",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "156.8",
scheduleHealth: "Not Active",
budgetHealth: "Not Active",
type: "Infrastructure",
workCalendar: "Default",
budget: "10000",
billingType: "FIXED_PRICE",
plannedRevenue: "21760",
plannedLaborRevenue: "21760",
fixedPrice: "8000",
plannedEffort: "156.8",
actualLaborHours: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
remainingEffort: "156.8",
plannedCost: "24480",
actualCost: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
plannedLaborCost: "24480",
actualLaborCost: "0",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "-2720",
plannedMargin: "-12.5",
actualProfit: "0",
actualMargin: "0",
projectedCost: "10400",
projectedLaborHours: "80",
actualRevenue: "0",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "25",
benefit: "75",
risk: "HIGH",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "58",
bcwp: "",
bcws: "",
acwp: "0",
team: "Executive, Tony Stark, Peter Parker, Team Member",
custom_country: "America|Canada",
custom_numeric_type: 20,
manager: "https://app.celoxis.com/psa//api/v2/projects/1234/manager",
clients: "https://app.celoxis.com/psa//api/v2/projects/1234/clients",
},
],
totalRecords: 1,
}Filter by a parent custom field
Fetch all tasks having custom field Country, whose formula key is country, equal to America.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"project.custom_country":"America"}' \
'https://app.celoxis.com/psa/api/v2/tasks'Response
{
data: [
{
id: "123456",
url: "https://app.celoxis.com/psa/tasks/123456",
name: "api time entry task",
description: "",
hierarchy: "",
topmostTask: "api time entry task",
sN: "4",
wbs: "4",
color: "",
plannedStart: "2019-08-05",
plannedStartWeek: "32-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
plannedFinish: "2019-08-05",
plannedFinishWeek: "32-2019",
plannedFinishMonth: "2019-08",
plannedFinishQuarter: "Q3 2019",
plannedFinishYear: "2019",
plannedFinishFiscalYear: "2019",
actualStart: "",
actualStartWeek: "",
actualStartMonth: "",
actualStartQuarter: "",
actualStartYear: "",
actualStartFiscalYear: "",
actualFinish: "",
actualFinishWeek: "",
actualFinishMonth: "",
actualFinishQuarter: "",
actualFinishYear: "",
actualFinishFiscalYear: "",
projectedStart: "",
projectedStartWeek: "",
projectedStartMonth: "",
projectedStartQuarter: "",
projectedStartYear: "",
projectedStartFiscalYear: "",
projectedFinish: "",
projectedFinishWeek: "",
projectedFinishMonth: "",
projectedFinishQuarter: "",
projectedFinishYear: "",
projectedFinishFiscalYear: "",
projectedCost: "0",
actualRevenue: "0",
plannedEffort: "0",
scheduleType: "FIXED_WORK",
duration: "1d",
predecessors: "",
successors: "",
constraintType: "ASAP",
constraintDate: "",
priority: "NORMAL",
actualPercentComplete: "0",
remainingEffort: "0",
created: "2019-09-04",
lastModified: "2019-09-04",
lastUpdate: "",
allUpdates: "",
lastUpdated: "2019-09-04",
resources: "",
scheduleHealth: "Not Active",
budgetHealth: "Not Active",
plannedRevenue: "0",
plannedLaborRevenue: "0",
budget: "0",
fixedPrice: "0",
billingType: "FIXED_PRICE",
plannedCost: "0",
actualCost: "0",
actualLaborHours: "0",
myEstHours: "0",
myActHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
plannedFixedCost: "0",
plannedNonLaborCost: "0",
plannedLaborCost: "0",
actualNonBillableLaborAmount: "0",
actualBillableLaborAmount: "0",
actualBillableExpense: "0",
actualNonBillableExpense: "0",
actualLaborCost: "0",
actualNonLaborCost: "0",
actualFixedCost: "0",
projectedLaborHours: "0",
attachments: "",
milestone: "No",
isManuallyScheduled: "No",
isTimeAllowed: "Yes",
critical: "No",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "0",
baselineStart: "",
baselineStartVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "",
showInTimeline: "No",
externalKey: "",
custom_kanban_state: "Backlog",
custom_single_select: "",
custom_text: "",
project: "https://app.celoxis.com/psa//api/v2/tasks/123456/project",
parent: "https://app.celoxis.com/psa//api/v2/tasks/123456/parent",
assignments: "https://app.celoxis.com/psa//api/v2/tasks/123456/assignments",
},
{
id: "123457",
url: "https://app.celoxis.com/psa/tasks/123457",
name: "API Task",
description: "",
hierarchy: "",
topmostTask: "API Task",
sN: "5",
wbs: "5",
color: "",
plannedStart: "2019-08-05",
plannedStartWeek: "32-2019",
plannedStartMonth: "2019-08",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
plannedFinish: "2019-08-05",
plannedFinishWeek: "32-2019",
plannedFinishMonth: "2019-08",
plannedFinishQuarter: "Q3 2019",
plannedFinishYear: "2019",
plannedFinishFiscalYear: "2019",
actualStart: "2019-09-04",
actualStartWeek: "36-2019",
actualStartMonth: "2019-09",
actualStartQuarter: "Q3 2019",
actualStartYear: "2019",
actualStartFiscalYear: "2019",
actualFinish: "",
actualFinishWeek: "",
actualFinishMonth: "",
actualFinishQuarter: "",
actualFinishYear: "",
actualFinishFiscalYear: "",
projectedStart: "",
projectedStartWeek: "",
projectedStartMonth: "",
projectedStartQuarter: "",
projectedStartYear: "",
projectedStartFiscalYear: "",
projectedFinish: "",
projectedFinishWeek: "",
projectedFinishMonth: "",
projectedFinishQuarter: "",
projectedFinishYear: "",
projectedFinishFiscalYear: "",
projectedCost: "0",
actualRevenue: "0",
plannedEffort: "0",
scheduleType: "FIXED_WORK",
duration: "1d",
predecessors: "",
successors: "",
constraintType: "ASAP",
constraintDate: "",
priority: "NORMAL",
actualPercentComplete: "20",
remainingEffort: "0",
created: "2019-09-04",
lastModified: "2019-09-04",
lastUpdate: "Peter Parker \u2022 Yesterday\r\ntask update created via api",
allUpdates: "Peter Parker \u2022 Yesterday\r\ntask update created via api",
lastUpdated: "2019-09-04",
resources: "",
scheduleHealth: "Not Active",
budgetHealth: "Not Active",
plannedRevenue: "0",
plannedLaborRevenue: "0",
budget: "0",
fixedPrice: "0",
billingType: "FIXED_PRICE",
plannedCost: "0",
actualCost: "0",
actualLaborHours: "0",
myEstHours: "0",
myActHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
plannedFixedCost: "0",
plannedNonLaborCost: "0",
plannedLaborCost: "0",
actualNonBillableLaborAmount: "0",
actualBillableLaborAmount: "0",
actualBillableExpense: "0",
actualNonBillableExpense: "0",
actualLaborCost: "0",
actualNonLaborCost: "0",
actualFixedCost: "0",
projectedLaborHours: "0",
attachments: "",
milestone: "No",
isManuallyScheduled: "No",
isTimeAllowed: "Yes",
critical: "No",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "0",
baselineStart: "",
baselineStartVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "",
showInTimeline: "No",
externalKey: "",
custom_kanban_state: "Backlog",
custom_single_select: "",
custom_text: "",
project: "https://app.celoxis.com/psa//api/v2/tasks/123457/project",
parent: "https://app.celoxis.com/psa//api/v2/tasks/123457/parent",
assignments: "https://app.celoxis.com/psa//api/v2/tasks/123457/assignments",
},
],
totalRecords: 2,
}Filter by a date field
Fetch all time entries between a date range.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"date":"-3d to Today"}' \
'https://app.celoxis.com/psa/api/v2/timeEntries'All the date filter options that work in Celoxis can be used here. If you want to use an absolute date, then its format should be the same as the user would input in a date field.
Response
{
data: [
{
id: "234567",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI1NzM0Ngieie",
accountingCode: "",
created: "2019-09-04",
date: "2019-09-04",
dateWeek: "36-2019",
dateMonth: "2019-09",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-09-04",
hours: 6.0,
comments: "",
timeCode: "Meeting",
state: "Saved",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/workItem",
yearWeek: "2019-36",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "No",
billRate: "300",
revenue: "0",
isCostable: "Yes",
costRate: "200",
cost: "1200",
user: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/user",
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/approver",
project: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/project",
},
{
id: "234568",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI1NzA4OAieie",
accountingCode: "",
created: "2019-09-04",
date: "2019-09-04",
dateWeek: "36-2019",
dateMonth: "2019-09",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-09-04",
hours: 5.2,
comments: "time entry submitted through api",
timeCode: "Default",
state: "Pending Approval",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/workItem",
yearWeek: "2019-36",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "Yes",
billRate: "100",
revenue: "520",
isCostable: "Yes",
costRate: "50",
cost: "260",
user: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/user",
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/approver",
project: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/project",
},
],
totalRecords: 3,
}Get more data of related entities (use of Expand)
Fetch all time entries between a date range along with data of project and user for each time entry.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"date":"2019-09-01 to 2019-09-08"}' \
'https://app.celoxis.com/psa/api/v2/timeEntries?expand=project,user'If there is no data related to the expanded field then the system will return null value for the same field.
Response
{
data: [
{
id: "234569",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTIzMTIyNgieie",
accountingCode: "",
created: "2019-08-29",
date: "2019-08-29",
dateWeek: "35-2019",
dateMonth: "2019-08",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-08-29",
hours: 8.0,
comments: "",
timeCode: "Sick Leave",
state: "Saved",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/234569/workItem",
yearWeek: "2019-35",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "No",
billRate: "300",
revenue: "0",
isCostable: "Yes",
costRate: "200",
cost: "1600",
user: {
data: {
id: "345678",
url: "https://app.celoxis.com/psa/users/345678",
name: "Tony Stark",
email: "tony.stark@celoxis.com",
phone: "123456",
login: "tony.stark",
lastAccessed: "2019-09-08T20:35:00",
workCalendar: "Default",
admin: "Yes",
virtual: "No",
reportingManager: "",
billRate: "300",
costRate: "200",
roles: "Staff",
jobRolePrimary: "",
},
},
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/234569/approver",
project: null,
},
{
id: "234569",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTIzMTI0Mgieie",
accountingCode: "",
created: "2019-08-29",
date: "2019-08-30",
dateWeek: "35-2019",
dateMonth: "2019-08",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-08-30",
hours: 4.0,
comments: "",
timeCode: "Default",
state: "Saved",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/234569/workItem",
yearWeek: "2019-35",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "Yes",
billRate: "300",
revenue: "1200",
isCostable: "Yes",
costRate: "200",
cost: "800",
user: {
data: {
id: "345678",
url: "https://app.celoxis.com/psa/users/345678",
name: "Tony Stark",
email: "tony.stark@celoxis.com",
phone: "123456",
login: "tony.stark",
lastAccessed: "2019-09-08T20:35:00",
workCalendar: "Default",
admin: "Yes",
virtual: "No",
reportingManager: "",
billRate: "300",
costRate: "200",
roles: "Staff",
jobRolePrimary: "",
},
},
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/234569/approver",
project: {
data: {
id: "1237",
url: "https://app.celoxis.com/psa/projects/1237",
name: "Project 3",
description: "",
code: "",
created: "2019-07-23",
lastModified: "2019-08-29",
plannedStart: "2019-06-24",
plannedStartWeek: "26-2019",
plannedStartMonth: "2019-06",
plannedStartQuarter: "Q2 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "2019-08-28",
deadlineWeek: "35-2019",
deadlineMonth: "2019-08",
deadlineQuarter: "Q3 2019",
deadlineYear: "2019",
deadlineFiscalYear: "2019",
plannedFinish: "2019-08-23",
projectedFinish: "2019-10-29",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "74",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "352.8",
scheduleHealth: "Off Track",
budgetHealth: "On Track",
type: "Infrastructure",
workCalendar: "Default",
budget: "65000",
billingType: "TNM",
plannedRevenue: "89400",
plannedLaborRevenue: "89400",
fixedPrice: "0",
plannedEffort: "352.8",
actualLaborHours: "109",
actualBillableLaborHours: "109",
actualNonBillableLaborHours: "0",
remainingEffort: "124.4",
plannedCost: "54120",
actualCost: "16300",
invoicedLaborHours: "20",
invoicedRevenue: "6000",
invoicedLaborAmount: "6000",
invoicedExpense: "0",
plannedLaborCost: "54120",
actualLaborCost: "16300",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "35280",
plannedMargin: "39.463",
actualProfit: "10900",
actualMargin: "40.074",
projectedCost: "22000",
projectedLaborHours: "143.89",
actualRevenue: "27200",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "65",
benefit: "65",
risk: "VERY_HIGH",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "16300",
team: "Tony Stark, Team Member",
custom_country: "",
custom_numeric_type: "",
manager: "https://app.celoxis.com/psa//api/v2/projects/1237/manager",
clients: "https://app.celoxis.com/psa//api/v2/projects/1237/clients",
},
},
},
{
id: "234567",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI1NzM0Ngieie",
accountingCode: "",
created: "2019-09-04",
date: "2019-09-04",
dateWeek: "36-2019",
dateMonth: "2019-09",
dateQuarter: "Q3 2019",
dateYear: "2019",
dateFiscalYear: "2019",
lastModified: "2019-09-04",
hours: 6.0,
comments: "",
timeCode: "Meeting",
state: "Saved",
workItem: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/workItem",
yearWeek: "2019-36",
approvedOn: "",
invoicedOn: "",
approvals: "",
isBillable: "No",
billRate: "300",
revenue: "0",
isCostable: "Yes",
costRate: "200",
cost: "1200",
user: {
data: {
id: "345678",
url: "https://app.celoxis.com/psa/users/345678",
name: "Tony Stark",
email: "tony.stark@celoxis.com",
phone: "123456",
login: "tony.stark",
lastAccessed: "2019-09-08T20:35:00",
workCalendar: "Default",
admin: "Yes",
virtual: "No",
reportingManager: "",
billRate: "300",
costRate: "200",
roles: "Staff",
jobRolePrimary: "",
},
},
approver: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/approver",
project: null,
},
],
totalRecords: 3,
}Filtering based on a multi-select custom field
Fetch all bugs where multi-select custom field, with formula key multi_select, is either one or two.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"custom_multi_select":["one","two"],"app":"Bug"}' \
'https://app.celoxis.com/psa/api/v2/apps'Response
{
data: [
{
id: "12345",
url: "https://app.celoxis.com/psa/apps/12345",
name: "Bug 7",
description: "",
app: "Bug",
state: "Reported",
age: "44d",
requestor: "",
dueDate: "",
created: "2019-07-23",
createdWeek: "30-2019",
createdMonth: "2019-07",
createdQuarter: "Q3 2019",
createdYear: "2019",
createdFiscalYear: "2019",
timeout: "",
completed: "",
priority: "NORMAL",
lastUpdate: "NEW → Reported\r\nTony Stark - 23-Jul-2019 6:53 PM\r\n",
lastUpdatedOn: "",
allUpdates: "NEW → Reported\r\nTony Stark - 23-Jul-2019 6:53 PM\r\n",
delayed: "No",
requestorVisible: "No",
open: "Yes",
stateManager: "Tony Stark",
actualRevenue: "0",
actualCost: "0",
actualEffort: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
custom_risk_impact: "",
custom_risk_probability: "",
custom_risk_potential_cost: "",
custom_risk_mitigation_cost: "",
custom_mitigation_plan: "",
custom_risk_rating: "",
custom_bug_type: "Bug",
custom_bug_severity: "Minor",
custom_bug_component: "Component 3",
custom_bug_resolution: "",
custom_bug_affects_version: "2.0",
custom_bug_fix_version: "",
custom_status_schedule: "",
custom_status_budget: "",
custom_status_scope: "",
custom_status_quality: "",
custom_status_team: "",
custom_status_risk: "",
custom_status_issue: "",
custom_status_overall: "",
custom_status_date: "",
custom_status_dateWeek: "",
custom_status_dateMonth: "",
custom_status_dateQuarter: "",
custom_status_dateYear: "",
custom_status_dateFiscalYear: "",
custom_multi_select: "one|two",
project: "https://app.celoxis.com/psa//api/v2/apps/12345/project",
assignee: {
data: {
id: "417972",
url: "https://app.celoxis.com/psa/users/417972",
name: "Team Member",
email: "teammember@celoxis.com",
phone: "",
login: "teammember",
lastAccessed: "",
workCalendar: "Default",
admin: "No",
virtual: "No",
reportingManager: "Tony Stark",
billRate: "200",
costRate: "100",
roles: "Staff",
jobRolePrimary: "",
},
},
},
{
id: "12346",
url: "https://app.celoxis.com/psa/apps/12346",
name: "APP via API",
description: "Details related to the app",
app: "Bug",
state: "Reported",
age: "6d",
requestor: "",
dueDate: "2019-09-05",
created: "2019-08-30",
createdWeek: "35-2019",
createdMonth: "2019-08",
createdQuarter: "Q3 2019",
createdYear: "2019",
createdFiscalYear: "2019",
timeout: "",
completed: "",
priority: "NORMAL",
lastUpdate: "NEW → Reported\r\nTony Stark - 30-Aug-2019 5:25 PM\r\n",
lastUpdatedOn: "",
allUpdates: "NEW → Reported\r\nTony Stark - 30-Aug-2019 5:25 PM\r\n",
delayed: "No",
requestorVisible: "No",
open: "Yes",
stateManager: "Tony Stark",
actualRevenue: "0",
actualCost: "0",
actualEffort: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
custom_risk_impact: "",
custom_risk_probability: "",
custom_risk_potential_cost: "",
custom_risk_mitigation_cost: "",
custom_mitigation_plan: "",
custom_risk_rating: "",
custom_bug_type: "Improvement",
custom_bug_severity: "Major",
custom_bug_component: "Component 1",
custom_bug_resolution: "",
custom_bug_affects_version: "1.0",
custom_bug_fix_version: "2.0",
custom_status_schedule: "",
custom_status_budget: "",
custom_status_scope: "",
custom_status_quality: "",
custom_status_team: "",
custom_status_risk: "",
custom_status_issue: "",
custom_status_overall: "",
custom_status_date: "",
custom_status_dateWeek: "",
custom_status_dateMonth: "",
custom_status_dateQuarter: "",
custom_status_dateYear: "",
custom_status_dateFiscalYear: "",
custom_multi_select: "one",
project: "https://app.celoxis.com/psa//api/v2/apps/12346/project",
assignee: null,
},
],
totalRecords: 2,
}Filter by Manager
Fetch all projects having project manager id equal to 9876.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"manager.id":"9876"}' \
'https://app.celoxis.com/psa/api/v2/projects'Response
{
data: [
{
id: "1238",
url: "https://app.celoxis.com/psa/projects/1238",
name: "Office Setup",
description: "",
code: "cx312",
created: "2019-09-05",
lastModified: "2019-09-05",
plannedStart: "2019-09-02",
plannedStartWeek: "36-2019",
plannedStartMonth: "2019-09",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "",
deadlineWeek: "",
deadlineMonth: "",
deadlineQuarter: "",
deadlineYear: "",
deadlineFiscalYear: "",
plannedFinish: "2019-10-28",
projectedFinish: "2020-04-02",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "2",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "210.8",
scheduleHealth: "At Risk",
budgetHealth: "At Risk",
type: "Implementation",
workCalendar: "Default",
budget: "35000",
billingType: "TNM",
plannedRevenue: "53000",
plannedLaborRevenue: "53000",
fixedPrice: "0",
plannedEffort: "210.8",
actualLaborHours: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
remainingEffort: "210.8",
plannedCost: "31920",
actualCost: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
plannedLaborCost: "31920",
actualLaborCost: "0",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "21080",
plannedMargin: "39.774",
actualProfit: "0",
actualMargin: "0",
projectedCost: "48540",
projectedLaborHours: "357.7",
actualRevenue: "0",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "40",
benefit: "50",
risk: "HIGH",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "2",
bcwp: "",
bcws: "",
acwp: "0",
team: "Tony Stark, Peter Parker, Team Member",
custom_country: "Canada|Brazil",
custom_numeric_type: 40,
manager: "https://app.celoxis.com/psa//api/v2/projects/1238/manager",
clients: "https://app.celoxis.com/psa//api/v2/projects/1238/clients",
},
],
totalRecords: 1,
}Filter by Client
Fetch all projects having client id equal to 1236 along with data of its clients.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'filter={"client.id":"1236"}' \
'https://app.celoxis.com/psa/api/v2/projects?expand=clients'Response
{
data: [
{
id: "1238",
url: "https://app.celoxis.com/psa/projects/1238",
name: "Office Setup",
description: "",
code: "cx312",
created: "2019-09-05",
lastModified: "2019-09-05",
plannedStart: "2019-09-02",
plannedStartWeek: "36-2019",
plannedStartMonth: "2019-09",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "",
deadlineWeek: "",
deadlineMonth: "",
deadlineQuarter: "",
deadlineYear: "",
deadlineFiscalYear: "",
plannedFinish: "2019-10-28",
projectedFinish: "2020-04-02",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "2",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "210.8",
scheduleHealth: "At Risk",
budgetHealth: "At Risk",
type: "Implementation",
workCalendar: "Default",
budget: "35000",
billingType: "TNM",
plannedRevenue: "53000",
plannedLaborRevenue: "53000",
fixedPrice: "0",
plannedEffort: "210.8",
actualLaborHours: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
remainingEffort: "210.8",
plannedCost: "31920",
actualCost: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
plannedLaborCost: "31920",
actualLaborCost: "0",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "21080",
plannedMargin: "39.774",
actualProfit: "0",
actualMargin: "0",
projectedCost: "48540",
projectedLaborHours: "357.7",
actualRevenue: "0",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "40",
benefit: "50",
risk: "HIGH",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "2",
bcwp: "",
bcws: "",
acwp: "0",
team: "Tony Stark, Peter Parker, Team Member",
custom_country: "Canada|Brazil",
custom_numeric_type: 40,
manager: "https://app.celoxis.com/psa//api/v2/projects/1238/manager",
clients: {
data: [
{
id: "1236",
url: "https://app.celoxis.com/psa/clients/1236",
name: "Acme International",
email: "acme@celoxis.com",
phone: "",
parent: "",
hierarchy: "Acme International",
root: "Acme International",
login: "client2",
lastAccessed: "",
},
],
totalRecords: 1,
},
},
{
id: "1239",
url: "https://app.celoxis.com/psa/projects/1239",
name: "Project via API",
description: "Details related to the project",
code: "apiproject",
created: "2019-08-30",
lastModified: "2019-08-30",
plannedStart: "2019-09-02",
plannedStartWeek: "36-2019",
plannedStartMonth: "2019-09",
plannedStartQuarter: "Q3 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "2019-09-30",
deadlineWeek: "40-2019",
deadlineMonth: "2019-09",
deadlineQuarter: "Q3 2019",
deadlineYear: "2019",
deadlineFiscalYear: "2019",
plannedFinish: "",
projectedFinish: "",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "0",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "0",
scheduleHealth: "On Track",
budgetHealth: "On Track",
type: "Implementation",
workCalendar: "Default",
budget: "500000",
billingType: "FIXED_PRICE",
plannedRevenue: "0",
plannedLaborRevenue: "0",
fixedPrice: "44500",
plannedEffort: "0",
actualLaborHours: "0",
actualBillableLaborHours: "0",
actualNonBillableLaborHours: "0",
remainingEffort: "0",
plannedCost: "0",
actualCost: "0",
invoicedLaborHours: "0",
invoicedRevenue: "0",
invoicedLaborAmount: "0",
invoicedExpense: "0",
plannedLaborCost: "0",
actualLaborCost: "0",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "0",
plannedMargin: "0",
actualProfit: "0",
actualMargin: "0",
projectedCost: "0",
projectedLaborHours: "0",
actualRevenue: "0",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "75",
benefit: "25",
risk: "NORMAL",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "0",
bcwp: "",
bcws: "",
acwp: "0",
team: "Tony Stark",
custom_country: "",
custom_numeric_type: "",
manager: "https://app.celoxis.com/psa//api/v2/projects/1239/manager",
clients: {
data: [
{
id: "1236",
url: "https://app.celoxis.com/psa/clients/1236",
name: "Acme International",
email: "acme@celoxis.com",
phone: "",
parent: "",
hierarchy: "Acme International",
root: "Acme International",
login: "client2",
lastAccessed: "",
},
],
totalRecords: 1,
},
},
{
id: "1237",
url: "https://app.celoxis.com/psa/projects/1237",
name: "Project 3",
description: "",
code: "",
created: "2019-07-23",
lastModified: "2019-08-29",
plannedStart: "2019-06-24",
plannedStartWeek: "26-2019",
plannedStartMonth: "2019-06",
plannedStartQuarter: "Q2 2019",
plannedStartYear: "2019",
plannedStartFiscalYear: "2019",
deadline: "2019-08-28",
deadlineWeek: "35-2019",
deadlineMonth: "2019-08",
deadlineQuarter: "Q3 2019",
deadlineYear: "2019",
deadlineFiscalYear: "2019",
plannedFinish: "2019-08-23",
projectedFinish: "2019-10-24",
actualFinish: "",
priority: "NORMAL",
actualPercentComplete: "74",
state: "Active",
baselineStart: "",
baselineStartVariance: "",
baselineDeadline: "",
baselineDeadlineVariance: "",
baselineFinish: "",
baselineFinishVariance: "",
baselineCost: "",
baselineBudget: "",
baselinePercentComplete: "0",
baselineEffort: "",
baselineEffortVariance: "352.8",
scheduleHealth: "Off Track",
budgetHealth: "On Track",
type: "Infrastructure",
workCalendar: "Default",
budget: "65000",
billingType: "TNM",
plannedRevenue: "89400",
plannedLaborRevenue: "89400",
fixedPrice: "0",
plannedEffort: "352.8",
actualLaborHours: "109",
actualBillableLaborHours: "109",
actualNonBillableLaborHours: "0",
remainingEffort: "124.4",
plannedCost: "54120",
actualCost: "16300",
invoicedLaborHours: "20",
invoicedRevenue: "6000",
invoicedLaborAmount: "6000",
invoicedExpense: "0",
plannedLaborCost: "54120",
actualLaborCost: "16300",
plannedNonLaborCost: "0",
actualNonLaborCost: "0",
plannedFixedCost: "0",
actualFixedCost: "0",
plannedProfit: "35280",
plannedMargin: "39.463",
actualProfit: "10900",
actualMargin: "40.074",
projectedCost: "22000",
projectedLaborHours: "143.89",
actualRevenue: "27200",
actualNonBillableLaborAmount: "0",
actualNonBillableExpense: "0",
alignment: "65",
benefit: "65",
risk: "VERY_HIGH",
cpi: "",
spi: "",
costVariance: "",
scheduleVariance: "",
plannedPercentComplete: "100",
bcwp: "",
bcws: "",
acwp: "16300",
team: "Tony Stark, Team Member",
custom_country: "",
custom_numeric_type: "",
manager: "https://app.celoxis.com/psa//api/v2/projects/1237/manager",
clients: {
data: [
{
id: "1236",
url: "https://app.celoxis.com/psa/clients/1236",
name: "Acme International",
email: "acme@celoxis.com",
phone: "",
parent: "",
hierarchy: "Acme International",
root: "Acme International",
login: "client2",
lastAccessed: "",
},
],
totalRecords: 1,
},
},
],
totalRecords: 3,
}Return only selected columns (use of Fields)
Fetch time entries for project 1234, returning only a subset of columns. Use user.name and project.name in the fields array — not user or project.
curl -g -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: bearer YourTokenHere' \
-G --data-urlencode 'fields=["id","date","hours","comments","timeCode","state","user.name","project.name"]' \
--data-urlencode 'filter={"project.id":"1234"}' \
'https://app.celoxis.com/psa/api/v2/timeEntries'Response
{
data: [
{
id: "234567",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI1NzM0Ngieie",
date: "2019-09-04",
hours: 6.0,
comments: "",
timeCode: "Meeting",
state: "Saved",
user: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/user",
project: "https://app.celoxis.com/psa//api/v2/timeEntries/234567/project",
},
{
id: "234568",
url: "https://app.celoxis.com/psa/ap/aHR0cHM6Ly9hcHAuY2Vsb3hpcy5jb20vcHNhL3RlLkVkaXQud20iscF90c19pZD0yMTI1NzA4OAieie",
date: "2019-09-04",
hours: 5.2,
comments: "time entry submitted through api",
timeCode: "Default",
state: "Pending Approval",
user: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/user",
project: "https://app.celoxis.com/psa//api/v2/timeEntries/234568/project",
},
],
totalRecords: 2,
}