v1
latestOpenAPI 3.1.02026-07-2438302.6 MBGet Project Details
get/projects/{project_uid}
Path parameters
project_uidstring required
Response
200
Example response
{
"type": "success",
"data": {
"project_uid": "90c2dfd0-d185-11ee-bd2e-471adde8df3c",
"project_prefix": "Test ",
"project_number": 5,
"project_icon": "Testing",
"project_name": "color code",
"project_category": {
"category_uid": "63932f00-c3f8-11ee-8e97-5d343b8a24b1",
"category_name": "textttst",
"display_order": 1,
"created_at": "2024-02-05T07:30:08.514Z",
"updated_at": "2024-02-05T10:28:56.524Z",
"category_color": "#000",
"category_description": "<p>ff<br></p>",
"estimated_duration": {
"days": 1,
"hours": 1,
"minutes": 1
}
},
"project_priority": "MEDIUM",
"project_description": "some description about project",
"project_template": {
"template_uid": "51e984e1-964d-11ed-a3d1-295b79eb7eaa",
"template_name": "Test",
"template_config": {
"project_prefix": "Testing",
"project_icon": "color code",
"project_name": "FREE_TEXT",
"project_priority": "URGENT",
"project_description": "project_description",
"project_duration": 12,
"project_tags": [
"one"
],
"project_attachments": [
{
"attachment_uid": "51e984e0-964d-11ed-a3d1-295b79eb7eaa",
"file_name": "test",
"url": "test.com",
"_id": "63c670fa24d6764ba006432b",
"created_at": "2023-01-17T09:57:14.930Z"
}
],
"custom_fields": [
{
"label": "Text Input",
"type": "SINGLE_LINE",
"_id": "63c670fa24d6764ba006432c"
}
]
},
"is_active": true
},
"project_current_status": {
"project_status_uid": "9c481ec0-6b19-11ed-bae3-7da4b580c234",
"project_status_name": "Started",
"project_status_type": "STARTED",
"project_status_color": "rgb"
},
"project_completion_percentage": 90,
"project_start_date": "2021-11-01T18:30:00.000Z",
"project_end_date": "2021-12-01T18:30:00.000Z",
"project_actual_start_date": "2021-11-01T18:30:00.000Z",
"project_actual_end_date": "2021-12-01T18:30:00.000Z",
"project_service_address": {
"landmark": "near jain college",
"city": "Thoraipakkam ",
"state": "Tamil Nadu ",
"street": "Jain College, D B Jain College main enterence, Jothi Nagar",
"country": "India",
"zip_code": "600097",
"geo_cordinates": [
12.9469543
],
"first_name": "Test",
"last_name": "User",
"phone_number": "1234567890",
"email": "testuser@yopmail.com"
},
"project_billing_address": {
"landmark": "near jain college",
"city": "Thoraipakkam ",
"state": "Tamil Nadu ",
"street": "Jain College, D B Jain College main enterence, Jothi Nagar",
"country": "India",
"zip_code": "600097",
"geo_cordinates": [
12.9469543
],
"first_name": "Test",
"last_name": "User",
"phone_number": "1234567890",
"email": "testuser@yopmail.com"
},
"project_due_date": "2021-12-01T18:30:00.000Z",
"organization": {
"is_active": true,
"organization_address": {
"city": "Chennai ",
"state": "Tamil Nadu ",
"street": "Amelio Early Education - Ascendas IT Park, CSIR Road, Tharamani, India",
"geo_cordinates": [
12.9855685
]
},
"organization_name": "Ascendas",
"organization_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/acb9ba40-8211-11eb-ab1f-1ddf213d24b4.jpg",
"organization_email": "ascendas@abc.com",
"organization_description": "<p><span style=\"background-color: rgb(255, 255, 0); color: #000000;\">Ascendas</span> is located in <strong>Taramani</strong>. It has <span style=\"background-color: rgb(239, 239, 239); color: #ff0000;\">3 phases. </span>asd sad gfgf fgfg dfdf dfrg dfdf dfddd ddfd dfdf dfd asdasd</p>\n<ol>\n<li>one</li>\n<li>two</li>\n<li>three</li></ol><p><a href=\"https://www.apple.com/in/apple-watch-ultra/\">link</a><br></p><ol>\n</ol>",
"organization_billing_address": {
"city": "Chennai",
"state": "Tamil Nadu",
"street": "Ascendas Phase 1",
"landmark": "Near Taramani bus stand"
},
"organization_uid": "11d86a70-8212-11eb-ab1f-1ddf213d24b4",
"no_of_customers": 43,
"custom_fields": [
{
"label": "LookUp",
"type": "LOOKUP",
"_id": "6401c0251c380c4e487555a6"
}
],
"created_at": "2021-03-11T02:32:48.537Z",
"updated_at": "2023-03-14T14:29:04.606Z"
},
"customer": {
"customer_first_name": "Mark",
"customer_email": "gprasath630@gmail.com",
"customer_company_name": "koffee Co",
"customer_uid": "63bc8020-4858-11e8-83d8-9df89bc5d31b",
"updated_at": "2023-03-16T11:42:59.166Z",
"created_at": "2018-04-25T07:15:10.242Z",
"custom_fields": [
{
"label": "Gorgias ID",
"type": "SINGLE_LINE",
"_id": "6406d2175f58013486104a22"
}
],
"customer_contact_no": {
"work": "9600970166"
},
"is_active": true,
"customer_last_name": "Arnold",
"accounts": {
"ltv": 11628817.246,
"receivables": 126285.532,
"credits": 15215.942
}
},
"assets": [
{
"asset": {
"asset_code": "AC002",
"asset_name": "Air Conditioner",
"asset_quantity": 1,
"purchase_date": "2019-12-02T18:30:00.000Z",
"warranty_expiry_date": "2019-11-28T18:29:00.000Z",
"placed_in_service": "2019-11-28T18:30:00.000Z",
"asset_uid": "596b4dc0-025d-11ea-af45-bd1d48d9fadb",
"updated_at": "2022-08-18T06:02:03.456Z",
"created_at": "2019-11-08T19:24:14.366Z",
"is_active": true,
"custom_fields": [
{
"label": "Text Input",
"type": "SINGLE_LINE",
"_id": "62fdd5cae435f974531ab170"
}
],
"asset_category": "5e986aadcbb0a15839381b24"
}
}
],
"jobs": [
{
"job": {
"job_uid": "b917bbf0-c64b-11ec-a683-c7d53138532e",
"prefix": "2022 -",
"job_title": "test",
"job_priority": "HIGH",
"scheduled_start_time": "2023-03-30T07:34:00.000Z",
"scheduled_end_time": "2023-03-30T16:34:00.000Z",
"customer_address": {
"city": "Chennai ",
"state": "Tamil Nadu ",
"street": "SKCL Harmony Square, Prakasam Street, Gangai Karai Puram, T. Nagar",
"country": "India",
"zip_code": "600017",
"geo_cordinates": [
13.0242729
],
"first_name": "Charles",
"last_name": "Customer",
"email": "Charles@Zuper.co"
},
"customer_billing_address": {
"city": "Chennai",
"state": "Tamil Nadu",
"street": "22E ,Thiru Vi Ka Industrial Estate ,Saidapet",
"country": "India",
"zip_code": "600032",
"first_name": "Charles",
"last_name": "Customer",
"email": "Charles@Zuper.co"
},
"custom_fields": [
{
"label": "J-ID",
"value": "30143524",
"type": "SINGLE_LINE",
"_id": "626976fb5c29f9288365ccb7"
}
],
"created_at": "2022-04-27T17:01:47.187Z",
"updated_at": "2023-03-16T07:11:51.804Z",
"work_order_number": 5470,
"due_date": "2023-01-31T00:00:00.000Z"
}
}
],
"attachments": [
{
"attachment_uid": "908f73c0-d185-11ee-bd2e-471adde8df3c",
"file_name": "test",
"url": "example.com",
"created_by": {
"user_uid": "d083c6cb-9202-41fc-8ae2-e986939c5471",
"first_name": "Jerin",
"last_name": "Aj",
"email": "jerin@zuper.co",
"designation": "Admin",
"emp_code": "J001",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/9f1e58b0-5396-11ee-af3b-ed82d39ae946.jpg",
"hourly_labor_charge": 54.59,
"is_active": true,
"created_at": "2022-02-16T10:00:42.000Z",
"updated_at": "2023-09-15T07:08:08.000Z"
},
"created_at": "2024-02-22T13:23:28.482Z"
}
],
"project_manager": {
"user_uid": "6c513b60-ff7c-11e7-b3a8-29b417a4f3fa",
"first_name": "Raghav",
"last_name": "G",
"email": "raghav@zuper.co",
"home_phone_number": "7397722822",
"designation": "CTO",
"emp_code": "1234",
"work_phone_number": "7397722822",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/3d87e6d0-e8d8-11ed-adf9-a5fc91f5c57c.jpeg",
"hourly_labor_charge": 500,
"is_active": true,
"created_at": "2024-01-16T13:59:59.000Z",
"updated_at": "2024-01-16T13:59:59.000Z"
},
"project_tags": [
"tag 1"
],
"custom_fields": [
{
"label": "Sage Customer ID",
"type": "SINGLE_LINE",
"_id": "65d74ad07c7dec84e778b6cc"
}
],
"project_assigned_to": [
{
"user": {
"user_uid": "6c513b60-ff7c-11e7-b3a8-29b417a4f3fa",
"first_name": "Raghav",
"last_name": "G",
"email": "raghav@zuper.co",
"home_phone_number": "7397722822",
"designation": "CTO",
"emp_code": "1234",
"work_phone_number": "7397722822",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/3d87e6d0-e8d8-11ed-adf9-a5fc91f5c57c.jpeg",
"hourly_labor_charge": 500,
"is_active": true,
"created_at": "2024-01-16T13:59:59.000Z",
"updated_at": "2024-01-16T13:59:59.000Z"
},
"team": {
"team_uid": "18cada40-021b-11e8-8127-43a5add1a9e2",
"team_name": "SF Team",
"team_color": "#3498db",
"is_active": true
}
}
],
"project_public_url": "hello.com",
"is_active": true,
"created_by": {
"user_uid": "d083c6cb-9202-41fc-8ae2-e986939c5471",
"first_name": "Jerin",
"last_name": "Aj",
"email": "jerin@zuper.co",
"designation": "Admin",
"emp_code": "J001",
"profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/9f1e58b0-5396-11ee-af3b-ed82d39ae946.jpg",
"hourly_labor_charge": 54.59,
"is_active": true,
"created_at": "2022-02-16T10:00:42.000Z",
"updated_at": "2023-09-15T07:08:08.000Z"
},
"config": {
"dependency": {
"day_shifting": "MAINTAIN",
"consider_weekend": true
}
},
"products": [
{
"line_item_uid": "4ad3e947-e94e-4abc-800c-4021f9ab69f5",
"line_item_type": "ITEM",
"product_ref_id": "662a0143048d9b94b311311f",
"location": "662b9deeb53b938957d94142",
"product_id": "12345",
"product_uid": "853ba100-02d2-11ef-a901-1f3e4d8db41e",
"location_uid": "7d905c10-03c8-11ef-94cd-01f7121eb721",
"group_uid": "a03a735c-65a7-4aca-b692-be803413f5e2",
"group_name": "general",
"group": "666ace8012141b49b6ff98d3",
"location_name": "chennai",
"image": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/702eaeb0-02d2-11ef-a901-1f3e4d8db41e.png",
"name": "AC",
"brand": "ups",
"planned": {
"quantity": 1
},
"available": {
"quantity": 1
},
"unit_price": 1,
"discount_type": "FIXED",
"total": 1,
"_id": "666c335303437795e7436cc7"
}
],
"created_at": "2024-02-22T13:23:28.505Z",
"updated_at": "2024-02-22T13:23:28.505Z",
"project_number_string": "Test 1",
"project_priority_index": 1,
"items": {
"property": {
"no_of_jobs": 1,
"is_active": true,
"property_uid": "b7c98360-5e9f-11eb-98dc-79c25d781098",
"property_name": "Abbotts Way School",
"property_address": {
"city": "Meare",
"landmark": "St Marys Road",
"zip_code": "BA6 9SR"
},
"custom_fields": [
{
"_id": "600e09140568ea403df944c5",
"label": "Zoho Site ID",
"type": "SINGLE_LINE"
}
],
"created_at": "2021-01-24T23:56:04.120Z",
"updated_at": "2021-01-24T23:56:04.122Z"
}
}
}
}