Projects

List projects

Filtered request example — Open projects owned by one user that started this quarter:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/projects.json?conditions[project_status]=open&conditions[project_owner]=13&conditions[project_start_date][selection]=this_quarter&per_page=50"
get/projects

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/projects
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

project_idstring

Comma-separated list of project IDs to return

project_namestring

Returns records that match a LIKE query on the name field

project_ownerinteger

Returns records owned by the User with this ID

project_status'open' | 'closed'

Returns records with the given status

project_is_archived'Yes' | 'No'

Returns records with the given archived status

Filters as bracketed query parameters, for example ?conditions[project_status]=open&conditions[project_start_date][selection]=this_quarter. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.

{
  "project_id": "111,112,113",
  "project_name": "Website",
  "project_owner": 13473,
  "project_status": "open",
  "project_is_archived": "Yes",
  "project_start_date": "last_30",
  "project_end_date": "last_30",
  "project_created_at": "last_30",
  "project_updated_at": "last_30"
}

Response

Successful Response

Example response

{
  "entries": [
    {
      "id": 91,
      "archived_at": "2025-03-01 10:00:00",
      "is_active": true,
      "created_by_user_id": 13473,
      "owner": {
        "id": 13,
        "full_name": "Sam Okafor"
      },
      "created_by_user": {
        "id": 27,
        "full_name": "Priya Natarajan"
      },
      "counts": {
        "deals": 2,
        "people": 3,
        "companies": 1,
        "milestones": 4
      },
      "stats": {
        "open_deals_value": 24000,
        "won_deals_value": 12000
      },
      "deals": [
        {
          "id": 4521,
          "name": "Acme Corporation - Q4 renewal"
        }
      ],
      "companies": [
        {
          "id": 3310,
          "name": "Acme Corporation"
        }
      ],
      "people": [
        {
          "id": 8802,
          "first_name": "Jane",
          "last_name": "Rivera"
        },
        {
          "id": 8815,
          "first_name": "Marcus",
          "last_name": "Chen"
        }
      ],
      "collaborators": [
        {
          "id": 27,
          "first_name": "Priya",
          "last_name": "Natarajan"
        }
      ],
      "milestones": [
        {
          "id": 88,
          "name": "Discovery complete",
          "due_date": "2026-09-30"
        }
      ],
      "project_milestones": [
        {
          "id": 88,
          "name": "Discovery complete",
          "status": "in_progress"
        }
      ],
      "deal_ids": [
        1,
        2,
        3
      ],
      "person_ids": [
        100,
        200
      ],
      "company_ids": [
        10,
        20
      ],
      "custom_fields": {
        "custom_label_90": "text val",
        "custom_label_5": 42
      },
      "created_at": "2026-09-01 14:22:07",
      "updated_at": "2026-09-01 14:22:07",
      "name": "Acme onboarding",
      "description": "Complete redesign of the company website with new branding",
      "status": "open",
      "start_date": "2026-09-15",
      "end_date": "2026-12-15",
      "owner_id": 13473,
      "hex_color": "#4A90D9",
      "user_ids": [
        5,
        6
      ],
      "team_ids": [
        1
      ],
      "project_milestones_attributes": [
        {
          "name": "Phase 1 - Discovery",
          "project_milestone_status_id": 1,
          "start_date": "2025-01-15",
          "end_date": "2025-02-28"
        }
      ],
      "project_template_id": 6,
      "source_deal_id": 42
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.