Documentation

Query Projects

GET /projects/{site_id}
GET /projects

Retrieves a list of projects for a site. By default, it only returns the projects which a user is a member of. If the user is a site admin for the site, they can use the all_projects flag to pull down all the projects for a site.

Path Parameters

Parameter Type Required Description
site_id string No Site ID where the projects will be retrieved from. If not provided, it will default to retrieving all projects accessible by the authenticated user

Query Parameters

Repeat project_ids, project_tag_ids, or statuses to pass multiple values. Their [] forms are also accepted. Send both sort_atr and sort_ord to change the default name-ascending order.

Parameter Type Description
all_projects boolean With a site ID and site-wide project edit access, includes all projects in that site.
all_projects_for_site_or_user boolean With a site ID and site-wide project edit access, includes all projects in that site.
count_only boolean Returns the matching numitems with an empty data array
created_end integer Unix timestamp representing the end of creation date range
created_start integer Unix timestamp representing the start of creation date range
exclude_view_only boolean Excludes projects that are view-only
for_kiosks boolean Limits project data to only what is needed for kiosks
from_user_view string User ID to view projects from the perspective of another user. Requires site-wide project edit access when a site is specified
include_creator boolean Includes the creator information in the response. Requires all_projects flag to be set
include_tags boolean Includes project tags in the response
inject_project_id string Injects a specific project into the response
last_modified_end integer Unix timestamp representing the end of last modified date range
last_modified_start integer Unix timestamp representing the start of last modified date range
limit integer Limits the number of projects returned
offset integer Offsets the starting point for retrieving projects
only_active boolean Only returns active projects. Default is True
only_inactive boolean Only returns inactive projects
project_id string Filters by project ID
project_ids array of strings Filters by multiple project IDs
project_tag_ids array of strings Filters by project tag IDs
reservable_id string Filters by reservable ID
search string Searches for projects by name or description
search_limited string Limited search for projects by name or description
sort_atr string Sorts projects by a specific attribute. Allowed values: site_name, name, description, project_string_id, status, active, created, last_modified
sort_ord string Sort order for the specified attribute. Allowed values: asc, desc
status string Filters by project status. Allowed values are active, canceled, completed, delayed, inactive, needs_changes, and preliminary.
statuses array of strings Filters by multiple project statuses
user_id string Filters by user ID
usergroup_id integer Filters by user group ID

Response

Success Response (200 OK)

data contains project objects and numitems counts matches before pagination. With count_only=true, data is [].

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to retrieve projects on this site

See the Projects API overview for related endpoints.