v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB
Projects

Get project

Get project

get/accounting/projects/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Response

Projects

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "Projects",
  "operation": "one",
  "data": {
    "id": "12345",
    "downstream_id": "12345",
    "name": "Website Redesign Project",
    "display_id": "PROJ-001",
    "reference_id": "WD-REF-2024-001",
    "description": "Complete redesign of the company website including new branding and improved user experience",
    "status": "active",
    "active": true,
    "project_type": "client_project",
    "priority": "high",
    "completion_percentage": 75.5,
    "start_date": "2024-01-15",
    "end_date": "2024-06-30",
    "completion_date": "2024-08-06",
    "customer": {
      "id": "12345",
      "display_id": "CUST00101",
      "display_name": "Windsurf Shop",
      "name": "Windsurf Shop",
      "company_name": "The boring company",
      "email": "boring@boring.com"
    },
    "department": {
      "id": "DEPT-001",
      "name": "Marketing"
    },
    "company_id": "12345",
    "owner_id": "12345",
    "parent_project": {
      "id": "PROJ-PARENT-001",
      "name": "Company Website Overhaul"
    },
    "currency": "USD",
    "budget_amount": 50000,
    "approved_amount": 48000,
    "actual_amount": 45250.75,
    "budget_hours": 400,
    "actual_hours": 385.5,
    "hourly_rate": 125,
    "billing_method": "time_and_materials",
    "is_billable": true,
    "phase": "execution",
    "tax_rate": {
      "id": "123456",
      "code": "N-T",
      "name": "GST on Purchases",
      "rate": 10
    },
    "tracking_categories": [
      {
        "id": "123456",
        "code": "100",
        "name": "New York",
        "parent_id": "123456",
        "parent_name": "New York"
      }
    ],
    "tags": [
      "website",
      "redesign",
      "urgent"
    ],
    "notes": "Client has requested modern design with mobile-first approach",
    "contract_number": "CNT-2024-001",
    "profit_margin": 15.5,
    "schedule_status": "on_schedule",
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "line5": "Attention: Finance Dept",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      }
    ],
    "team_size": 8,
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "row_version": "1-12345",
    "updated_by": "12345",
    "created_by": "12345",
    "created_at": "2020-09-30T07:43:32.000Z",
    "updated_at": "2020-09-30T07:43:32.000Z"
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}