CIcint
Projects

List projects for an account

This endpoint returns a paginated list of projects for a specific account. The response includes summary details for each project, such as its name, last activity, and key statistics.

get/demand/accounts/{account_id}/projects

Request

Query parameters

project_manager_idstring uuid

A unique identifier for the user.

Example:b551326b-ac9d-4d32-8823-4f025787dab9

Filters the list of projects by the assigned project manager's ID.

status'active' | 'inactive'

The status of the project.

Example:active

Filters the list of projects by their status.

namestring
Example:Test Project

Deprecated: Use the search_string parameter instead.

Filters by the project name. If only name is supplied, it is treated as a search_string. If both name and search_string are supplied, name is ignored.

search_stringstring
Example:Test Project

Searches for projects based on a string match in any of the following fields.

  • Project name
  • Project's human-readable ID
  • Human-readable IDs of any target groups within the project
end_beforestring

Returns a list of objects that come before the provided pagination cursor. This is used for navigating to a previous page.

start_afterstring

Returns a list of objects after the provided pagination cursor, using the next_cursor from the previous response.

page_sizeinteger

A limit on the number of objects to be returned, between 1 and 100.

Response

Returns a paginated list of projects.

urlstring required

URL which produced this list (without query parameters).

has_moreboolean required

If true, there are more results to fetch by providing the next_cursor in a subsequent request. If false, you are on the last page of results.

next_cursorstring nullable

An identifier for pagination that indicates there are more items available. When present, use this value to retrieve the next page of results.

Example response

{
  "projects": [
    {
      "id": "01HD6WD8W4G8FMTFCX0JPR8TXN",
      "human_readable_id": "FT354J",
      "account_id": 101,
      "project_customer_reference_number": "RF-4567",
      "name": "Test Project",
      "highlighted_name": "<em>Test</em> Project",
      "target_group_human_readable_ids": [
        "9NRV3B9"
      ],
      "target_group_count": 1,
      "status": "active",
      "last_activity_at": "2023-01-01T23:00:00.000Z",
      "statistics": {
        "filling_goal": 1000,
        "current_completes": 412,
        "current_prescreens": 546,
        "incidence_rate_median": 0.05,
        "length_of_interview_median_seconds": 1,
        "conversion_rate_average": 0.05,
        "drop_off_rate_average": 0.05
      },
      "target_group_customer_reference_numbers": [
        "AB-00246246"
      ]
    }
  ],
  "url": "/accounts/543587/projects",
  "next_cursor": "bff6a669-a469-409d-8c94-dcf92258043a"
}

Changes

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