Projects

Required. The ID of the community whose projects you want to list. The caller must be an approved member of that community.

The number of projects to skip. Defaults to 0. Pending projects are only returned when skip is 0.

The maximum number of projects to return. 0 — the default — returns every match. The filter also accepts pageSize as an alias, which is only applied when take is absent or 0.

Free-text search across the project name and intro text. When it is set, full-text ranking replaces orderBy.

Sort order, sent as an integer: 0 name A→Z, 1 most recently created, 2 most viewed, 3 most commented, 4 most members, 5 most recently updated. Ignored when concept is set.

Restricts the list by country. Described under countryFilter object below.

Restricts the list by UN Sustainable Development Goal. Same shape as countryFilter, with values holding goal IDs.

Restricts the list by industry category. Same shape as countryFilter, with values holding category IDs.

Restricts the list by program (methodology). Same shape as countryFilter, with values holding program IDs.

Restricts the list by development stage. Same shape as countryFilter, except values is an array of stage key strings.

Restricts the list by project tag. Same shape as countryFilter, except values is an array of tag names.

Restricts the list by the answers projects gave on the community's project form. Described under filters array items below.

How to apply values, sent as an integer: 0 keeps projects matching any of the values, 1 excludes projects matching any of them.

The IDs to match. developmentStageFilter and tagFilter take an array of strings here instead — stage keys and tag names respectively.

0 keeps projects whose answer is any of answers, 1 excludes them.

The exact question text from the community's project form, as returned in projectFilters.filters[].question.

The answer values to match, as returned in projectFilters.filters[].answers.

Whether the calling user may create a project in this community. true for an approved community member whose community circle grants the create-project permission.

Whether the calling user may invite other people to projects in this community.

Whether the calling user may approve project paragraphs submitted for review in this community.

Whether project creation is currently locked at community level. When true, nobody can create a project even if canCreateProjects is true.

Whether the calling user may open the community's project-overview (tracking) screens.

Projects awaiting approval into this community. Only returned to community administrators, and only on the first page — a skip of 0. An empty array otherwise. Described under pendingProjects array items below.

The paginated result set of approved projects. Described under projects object below.

The filter facets available for this community's project list, derived from every project that matched the request rather than from the current page. Described under projectFilters object below.

Whether the calling user follows this project — that is, holds an approved project membership in any circle.

Whether the calling user may edit this project's information. Equivalent to being an approved member of the project's Team circle.

The project's tag names, de-duplicated. Empty when the project has no tags.

The UN Sustainable Development Goals linked to the project. Described under projectSustainableDevelopmentGoals array items below. Always empty for pendingProjects.

Whether the calling user is an approved member of the project's Team circle. Always mirrors canEditProjectInfo.

The ID of the project.

The project name.

The project's short description.

Server-relative path to the project logo image.

Whether mainImageOrVideo points at a video rather than an image.

The project's external website, or an empty string when none is set.

Server-relative path to the project's hero image, or the video URL when isVideo is true. An empty string when none is set.

The name of the project's country.

The project's city.

The project's latitude in decimal degrees. null when the project has no map position.

The project's longitude in decimal degrees. null when the project has no map position.

The name of the project's industry category.

The project's development-stage key, for example default_development_stage_idea. An empty string when the project has no stage set. Translate it through your locale files for display.

The name of the project's legacy UN goal. Always null on this endpoint.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

Whether the project may invite members and mentors from outside the community.

The ID of the project the goal is linked to. Always matches the enclosing element's id.

The ID of the UN Sustainable Development Goal. Resolve its name through projectFilters.sustainableDevelopmentGoals.

The total number of projects matching the filter, before skip and take are applied. Use it to drive pagination.

The current page of projects. Same shape as the pendingProjects array items above.

Always null on this endpoint. The available filter facets are returned in projectFilters instead.

The distinct countries of the matched projects, sorted by name. Described under projectFilters.countries array items below.

The distinct UN Sustainable Development Goals of the matched projects, sorted by name. Described under projectFilters.sustainableDevelopmentGoals array items below.

The distinct development-stage keys of the matched projects, sorted alphabetically. An empty string appears when some projects have no stage set.

The distinct industry categories of the matched projects, sorted by name. Described under projectFilters.industries array items below.

The distinct tag names across the matched projects, sorted alphabetically.

The community's filterable project-form questions and the answers currently in use. Described under projectFilters.filters array items below. Empty when the community has no project form, or when no question is marked filterable.

The programs (methodologies) the matched projects run in this community, sorted by name. Only returned when the community has more than one program; an empty array otherwise. Described under projectFilters.programs array items below.

The country name.

The ISO 3166-1 alpha-2 country code.

The country's default IANA time-zone name.

The ID of the country. This is what you send in countryFilter.values.

The goal's name.

The base file name of the goal's official icon asset.

The ID of the goal. It matches projectSustainableDevelopmentGoals[].sustainableDevelopmentGoalId and is what you send in sdgFilter.values.

The industry name.

Whether the industry was created by a user rather than shipped as a platform default.

The ID of the industry. This is what you send in industryFilter.values.

The text of a filterable question on the community's project form.

The distinct answer values available for that question. For choice questions these are the options at least one project selected, for country questions it is the full country list, and otherwise it is the distinct free-text answers.

The ID of the program (methodology). This is what you send in programFilter.values.

The program name.

The request is not authenticated.

The caller may not access the requested community, or the bearer token no longer resolves to a user. The body carries an error discriminator — CannotAccessToCommunityException or UserOauthExpiredException — alongside errorCode and message.

The ID of the community whose projects you want to track.

Free-text search over the project name.

Only return projects based in this country.

Only return projects in this industry category.

Only return projects carrying these tags. Repeat the parameter once per tag.

Only return projects linked to these UN Sustainable Development Goals. Repeat the parameter once per ID.

The number of projects to skip. Defaults to 0.

The maximum number of projects to return. 0 — the default — returns every match.

The ID of the project.

The project name.

Server-relative path to the project logo image.

The project's average completion across its active programs, as a whole-number percentage from 0 to 100.

The project's tag names.

The project's circles in this community. Described under projectCircles array items below.

The project's members in this community, including pending invitations and applications. Described under projectUsers array items below.

ISO-8601 UTC timestamp of the most recently published paragraph across the project's programs. null when the project has published nothing yet, or has no program attached.

The name of the program section the project most recently published into. An empty string when nothing has been published.

The number of mentoring requests recorded against the project.

The share of the project's KPI values that are still unset — recorded as 0 — as a whole-number percentage from 0 to 100.

The ID of the community-project link the circle belongs to. null for project-scoped circles such as Team.

Always null on this endpoint.

The ID of the project the circle belongs to. null for circles scoped to a community-project link.

Always null on this endpoint.

Always null on this endpoint. It is a write-only helper used when creating a circle.

The circle name, for example Team, Mentors or Followers.

Read-only. true when name is Team.

Read-only. true when name is Mentors.

Read-only. true when name is one of the three built-in circles Team, Mentors or Followers.

Read-only. true when the circle belongs to the project itself rather than to a community-project link.

Read-only. The circle's project ID. Always equals projectId on this endpoint.

The ID of the circle. It matches projectUsers[].projectCircleId.

The ID of the project circle the member belongs to. It matches an id in projectCircles.

true when the person asked to join the project and the team has not answered yet.

true when the team invited the person and they have not answered yet.

The circle the person asked to be moved into, when a circle-change request is open. null otherwise.

The ID of the user.

The user's first name.

The user's last name.

The user's email address.

Server-relative path to the stored profile picture.

The user's job title.

The user's biography, as HTML.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

The pending account-activation code, when the user has not activated their account yet.

Whether the activation code has been emailed.

Whether the user finished the profile-setup wizard.

The ID of the user's country.

The user's country. Described under projectUsers[].country object below. null when the user has no country set.

The user's city.

The user's latitude in decimal degrees. null when unknown.

The user's longitude in decimal degrees. null when unknown.

The user's company.

Whether the user is banned from the platform.

Whether the user's account is active.

The URL the user is redirected to after their first log-in, when they were invited.

The user's interface language tag, for example en-EN.

ISO-8601 UTC timestamp of when the user registered.

ISO-8601 UTC timestamp of the user's last log-in.

Whether the user receives notification emails.

The ID of the user's primary community.

The name of the user's primary community. Always null on this endpoint.

Whether the user has open mentoring requests.

Always null on this endpoint. Interests are returned by the user-profile endpoints.

Always null on this endpoint. Skills are returned by the user-profile endpoints.

Always null on this endpoint. Linked social accounts are returned by the user-profile endpoints.

Always null on this endpoint. Market expertise is returned by the user-profile endpoints.

Always null on this endpoint.

Always null on this endpoint.

Always null on this endpoint.

The version of the terms and conditions the user accepted.

The profile picture to display. The same as photo when one is uploaded, and null otherwise on this endpoint.

Always null on this endpoint.

Always null on this endpoint.

Always null on this endpoint.

Always null on this endpoint.

Always false on this endpoint.

The country name.

The ISO 3166-1 alpha-2 country code.

The country's default IANA time-zone name.

The ID of the country. It matches the member's countryId.

The request is not authenticated.

The caller does not belong to an approved community circle carrying the "access project overview" permission in the requested community.

The ID of the community whose KPI progress you want to retrieve.

The ID of the project the KPI series belong to.

The KPI series for this project — one entry per KPI definition, combining the definitions inherited from the project's programs (methodologies) with the project's own definitions. Empty when the project has no KPI definitions. Described under kpiChartReport array items below.

The KPI definition name and the project name joined with " - ", ready to use as a chart series label.

The first year the KPI is tracked from.

The first month the KPI is tracked from, 1 to 12.

The ID of the KPI definition this series belongs to.

The reporting interval in months: 1 monthly, 3 quarterly, 6 half-yearly, 12 yearly. The reported months are derived by stepping from kpiDefinitionStartMonth in increments of this value.

The recorded values for this KPI, ordered by the ID of the underlying entry and de-duplicated so that only the most recent entry per year and month survives. Empty when nothing has been reported yet. Described under kpiChartReport[].kpiValues array items below.

The ID of the program (methodology) the KPI definition belongs to, or null when the definition is scoped directly to the project instead of to a program.

Whether the KPI is derived from a survey question. Always false on this endpoint.

The ID of the KPI value entry. When several entries exist for the same year and month, the one with the highest ID wins.

The year the value was reported for.

The month the value was reported for, 1 to 12.

The reported value. null when the period was opened for reporting but no figure was entered.

The request is not authenticated.

The caller does not belong to an approved community circle carrying the "access project overview" permission in the requested community.

The ID of the project to retrieve.

The ID of the community to scope the overview to. Omit it for the standalone project view, or supply it for the project as seen inside that community. See the note above for exactly which fields change.

The ID of the project.

The project name.

The short project description.

Server-relative path to the project logo.

Whether mainImageOrVideo points at a video rather than an image.

The project's own website.

Server-relative path to the project cover image, or the video URL when isVideo is true.

The display name of the project's country. null on the standalone path.

The project's city.

The project's latitude in decimal degrees.

The project's longitude in decimal degrees.

The display name of the project's industry category.

The project's development stage, as free text.

The display name of the project's primary UN goal. null when the project has none, and on the standalone path.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

Reserved. Always 0 on this endpoint.

Whether the caller may invite people who are not yet platform users. Depends on the project setting and the caller's community membership.

Whether the caller administers the community the overview is scoped to. Always false when communityId is omitted.

Whether the caller may edit the project's descriptive content. true for project team members, and for community administrators when the project belongs to a single community.

Whether the caller may add or remove team members.

Whether the caller may create extra project circles for privacy. Requires the caller to be a team member and at least one of the project's communities to allow it. Always false when communityId is omitted.

Whether the caller may see the project's tasks.

Whether the caller follows the project.

Whether the caller is an approved member of the project.

Whether the caller has been invited by the team and has not yet accepted.

Whether the caller has asked to join and the team has not yet accepted.

The full Twitter URL, or null when no handle is set.

The full Facebook URL, or null.

The full Google URL, or null.

The full LinkedIn URL, or null.

The full Flickr URL, or null.

Just the handle or path portion of twitterUrl.

Just the handle or path portion of facebookUrl.

Just the handle or path portion of googleUrl.

Just the handle or path portion of linkedInUrl.

Just the handle or path portion of flickrUrl.

The number of discussions the caller may see in this community. 0 when communityId is omitted.

The number of resources the caller may see in this community. 0 when communityId is omitted.

The number of people connected to the project in this community. 0 when communityId is omitted.

Always 0 on this endpoint — use kpiDefinitions[].methodologyId or the programs endpoints instead.

The "problem solved" section of the project profile.

The "our solution" section of the project profile.

The "how we measure impact" section of the project profile.

Always "0001-01-01T00:00:00Z" on this endpoint, on both paths. Never null.

Who may invite people to the project, as the strictest policy across the communities in scope: 0 Undefined, 1 Anyone, 2 OnlyPlatformUsers, 3 OnlyCommunityUsers, 4 None (community administrators only). 4 when communityId is omitted, because no community policy applies.

Whether program paragraphs stay hidden until their scheduled date.

The ID of the project's country.

The ID of the project's industry category.

The ID of the project's primary UN goal, or null.

The project's business model, as free text.

Up to three program paragraphs that still have no content, ordered by section. Empty unless the caller is a project team member, and always empty when communityId is omitted. Described under pendingParagraphs array items below.

The project's approved team members. Described under team array items below.

Up to five active, non-archived discussions on the project, newest first. Always empty when communityId is omitted. Described under openDiscussions array items below.

The project's tags, de-duplicated. Always [] when communityId is supplied. Only the standalone path returns them, and there it is [] when the project has none.

The Sustainable Development Goals the project is aligned with. Same shape as the projectSustainableDevelopmentGoals array items documented under List projects above — projectId and sustainableDevelopmentGoalId.

The community the overview is scoped to, as a single-element array — not every community the project belongs to. [] when communityId is omitted, and [] when the requested community project is not approved, is disabled, or is not public. Use communities for the full list.

The community the overview is scoped to, or null when communityId is omitted, or when the community project is not approved or not public.

Every community the project is publicly visible in. On the standalone path this is the project's full public community list; when communityId is supplied it is narrowed to the communities the caller can see — team members see all of them. Described under communities array items below.

The community's project form — the extra questions this community asks its projects. null when the community has no project form, and always null when communityId is omitted. Described under form object below.

The project's answers to the community project form, across every round. null when communityId is omitted, and [] when the project has not answered anything. Described under answers array items below.

The KPI definitions that apply to the project — those inherited from its programs plus its own. null when communityId is omitted. Described under kpiDefinitions array items below.

Always null on this endpoint. Where populated, each element carries id, communityProjectId, communityCircleId, communityCircle and communityProject.

Always [] on this endpoint. Where populated, it holds community-circle tag names.

The ID of the community.

The community name.

Server-relative path to the community logo.

The ID of the project's paragraph record.

The title of the program paragraph that is still empty.

The ID of the program section the paragraph belongs to.

The program paragraph the discussion is attached to, or null for free-standing discussions.

Always null on this endpoint. Where populated, it holds up to five followers, each with id, firstName, lastName and photo.

The total number of followers. Always 0 on this endpoint.

The ID of the discussion.

The discussion title.

The number of comments on the discussion.

Server-relative path to the discussion's cover image.

ISO-8601 UTC timestamp of when the discussion was opened.

ISO-8601 UTC timestamp of when the discussion was last edited.

The computed deadline, derived from postDate and deadline. null when no deadline is set.

The deadline window: 0 Undefined, 1 Day, 2 Week, 3 Month, 4 Year, 5 Never. null when no deadline is set.

Whole days between now and deadlineDate. Negative once the deadline has passed, and null when there is no deadline.

Whether the discussion is open. Always true here — closed discussions are filtered out.

The ID of the user who opened the discussion.

The author's full name. Always null on this endpoint.

The author's avatar path. Always null on this endpoint.

The author's job title. Always null on this endpoint.

The discussion's tags, de-duplicated.

The circles the discussion is shared with, by name. Always null on this endpoint — only the discussion-list endpoints populate it.

The skill categories the discussion asks for help in. Always null on this endpoint — only the discussion-detail endpoint populates it.

Whether the discussion has been archived. Always false here — archived discussions are filtered out.

Whether commenting is locked. Always false on this endpoint — only the discussion-detail endpoint sets it.

Who can see the discussion: 0 Undefined, 1 Public, 2 Community, 3 Team, 4 Custom, 5 TeamAndMentors, 6 SetByTeam. Always 0 (Undefined) on this endpoint.

Whether the caller follows the discussion.

The number of times the discussion has been opened.

The ID of the form.

The form name.

The form description.

The ID of the community that owns the form.

The form family: 0 Undefined, 1 ApplicationDefinition, 2 Tab, 3 Evaluation. Always 0 for project forms.

ISO-8601 UTC timestamp of when the form was created.

ISO-8601 UTC timestamp of when the form was last edited.

Always 0 on this endpoint.

The form's questions. On this endpoint the list is not the raw form definition: it is the union of the community's default project form and any question from earlier rounds the project answered, with project-field questions removed, custom questions kept only when they belong to the default form or are flagged for the project profile, and per-round copies of default questions dropped. Described under form.questions array items below.

The form's sections, ordered. Always [] on this endpoint. Where populated, each section carries id, title, description and order.

Whether the form's answers are shown on the community landing page.

Whether this is the community's default project form.

The ID of the question.

The question's short title.

Helper text shown under the question.

The question text itself.

The question's position in the form.

Whether an answer is required.

Whether the answer can be changed after it has been submitted.

The input type: 0 RadioChoice, 1 CheckBoxChoice, 2 DropDownChoice, 3 MultipleChoice, 4 AccountMoney, 5 Calendar, 7 ShortText, 8 LongText, 9 File, 10 Scale, 11 Country, 12 Table, 13 Numeric. Negative values map the question onto a built-in project field and are filtered out of this endpoint's response.

Whether the question writes to a built-in project field instead of the answers table. Read-only, computed from answerType. Always false on this endpoint — such questions are filtered out.

Whether more than one option may be selected.

Reference links shown alongside the question. Described under form.questions[].questionLinks array items below.

The selectable options, ordered by questionOptionOrder — or alphabetically by label when answerType is 11 (Country). Described under form.questions[].questionOptions array items below.

Whether answers to this question can be used as a project-list filter. Filterable questions are the ones returned in projectFilters.filters by List projects.

Who can see the answer: 0 Undefined, 1 Public, 2 Community, 3 Team, 4 Custom, 5 TeamAndMentors, 6 SetByTeam.

The IDs of the community circles allowed to see the answer when privacyLevel is 4 (Custom). null when the question has no privacy-circle records.

How the entries in formQuestionConditionalLogicList combine: 0 None, 1 AnyConditional, 2 AllConditionals.

The conditions that must hold for this question to be shown. null when the question has no conditions. Described under form.questions[].formQuestionConditionalLogicList array items below.

Whether the question originated in an application form. Always false for project forms.

Whether the question carries an evaluation weight. Read-only, derived from weightedAverage. Always false for project forms.

The evaluation weight. Always null for project forms.

Whether numeric answers are turned into a KPI. Always false for project forms.

Which circle may change the question's privacy. Always 0 (Undefined) for project forms.

When the question is asked: 0 ProjectTemplate — part of the project profile — or 1 AfterProjectApproval.

Whether the question is shown on the project profile.

Whether the answer length is capped.

The unit the cap is expressed in: 1 Characters, 2 Words. null when hasLimit is false.

The cap itself, in the unit given by limitType.

The ID of the community default-form question this one was copied from. Always null on this endpoint — per-round copies are filtered out.

The ID of the form section the question belongs to, or null when it is not sectioned.

A reference URL shown with the question.

The ID of the option. This is what answers reference.

The option label.

The option's position in the list.

The ID of the condition.

The ID of the question whose answer the condition tests.

The option the condition tests against, for choice questions. null when the condition uses customValue instead.

The literal value the condition tests against, for free-text and numeric questions.

The comparison: 1 Equal, 2 NotEqual, 3 GreaterThen, 4 LessThen, 5 Contains, 6 DoesNotContain, 7 IsEmpty, 8 NotEmpty.

The ID of the answer.

The ID of the project form the answer was submitted against. Answers from earlier rounds keep their own form ID.

The ID of the form question being answered.

The ID of the user who submitted the answer.

ISO-8601 UTC timestamp of when the answer was last saved.

Only used by application-form answers. Always 0 here.

Only used by tab-form answers. Always 0 here.

Always 0 here — project form answers are keyed by community project, not by project. Use the top-level id for the project.

The answer payload. Free text for text questions, the selected option's ID as a string for choice questions, and a file path for file questions.

The position of this answer within a multi-select or table question. 0 for single answers.

The row index for table questions. 0 otherwise.

The ID of the program the KPI definition belongs to, or null for definitions scoped directly to the project.

The KPI name.

The reporting interval in months: 1 monthly, 3 quarterly, 6 half-yearly, 12 yearly.

Whether a higher value is the desired direction.

Whether the KPI is currently collected.

The first year the KPI is tracked from.

The first month the KPI is tracked from, 1 to 12.

Whether the definition has been soft-deleted. Always false here — removed definitions are filtered out.

The community project the definition is scoped to, or null for project-scoped and program-template definitions.

The community project the definition is scoped to. null for project-scoped and program-template definitions. Described under kpiDefinitions[].communityProject object below.

The project the definition is scoped to, or null for community-project-scoped and program-template definitions.

Always null here.

Always null here.

Whether the definition was generated from a survey question.

Read-only. true when the definition travels with the project across every community — that is, when projectId is set and communityProjectId is not.

Read-only. true when the definition is confined to one community — that is, when communityProjectId is set and projectId is not.

Read-only. true when the definition is the program's template row rather than a per-project copy — that is, when neither projectId nor communityProjectId is set.

The ID of the KPI definition. It matches kpiChartReport[].kpiDefinitionId on Get projects KPI progress.

The community side of the link.

The community record. Always null here.

The project side of the link.

The project record. Always null here.

Whether the community has approved the project.

Whether the link has been disabled.

Who may see the project inside the community: 0 Open, 1 InviteOnly, 2 Private.

The community's project form. Always null here.

The ID of the community's project form. It matches the top-level form.id.

The programs the project runs in this community. Always null here.

The community circles wired to this community project. Always null here.

The circle tags on this community project. Always null here.

The survey-derived KPIs for this community project. Always null here.

The ID of the community-project link row.

The request is not authenticated.

The project does not exist, is not in the requested community, has been disabled, or the caller may not see it — and the bearer token no longer resolving to a user lands here too. The body carries an error discriminator: ProjectNotFoundException, ProjectIsDisabledException, CannotAccessToProjectException or UserOauthExpiredException, alongside errorCode and message. Branch on error rather than on the status code.