> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/getprojectsbygroup.md). # GetProjectsByGroup ## Parameters The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory. ### Headers ``` GET /api/ss/groups/:id/projects HTTP/1.1 Host: demo.attackforge.com X-SSAPI-KEY: APIKey Content-Type: application/json Connection: close ``` ### Query **id (string)** Identifier for the group. Example: ``` GET /api/ss/groups/5e6880f33e6d520a26fef4b0/projects HTTP/1.1 ``` **cf\_key\_allowlist (string) (optional)** List of custom field keys to include in response. Add multiple for more than one key e.g. `?cf_key_allowlist=key1&cf_key_allowlist=key2` or specify no keys to exclude all fields e.g. `?cf_key_allowlist=` Example: ``` GET /api/ss/groups/5e6880f33e6d520a26fef4b0/projects?cf_key_allowlist=key1&cf_key_allowlist=key2 HTTP/1.1 ``` **cf\_key\_blocklist (string) (optional)** List of custom field keys to exclude from response. Add multiple for more than one key e.g. `?cf_key_blocklist=key1&cf_key_blocklist=key2` Example: ``` GET /api/ss/groups/5e6880f33e6d520a26fef4b0/projects?cf_key_blocklist=key1&cf_key_blocklist=key2 HTTP/1 ``` ## Example The following example is a cURL request to get all projects for a group. ### Request Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' parameter. ``` curl -X GET 'https://demo.attackforge.com/api/ss/groups/5e6880f33e6d520a26fef4b0/projects' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' ``` ### Response Response contains an array of project objects. ``` { "count": 999, "projects": [ { "project_id": "...", "project_name": "...", "project_code": "...", "project_organization_code": "...", "project_vulnerability_code": "..." "project_groups": [ { "id": "...", "name": "..." } ], "project_status": "...", "project_extended_status": "...", "project_testing_progress": "100%", "project_on_hold": "...", "project_start_date": "...", "project_end_date": "...", "project_scope": [ "..." ], "project_scope_details": [ { "id": "...", "name": "...", "asset_id": "..." } ], "project_scoring": "...", "project_team_notifications": [ "..." ], "project_admin_notifications": [ "..." ], "project_start_stop_testing_email": "...", "project_start_stop_testing_email_additional_recipients": [ "..." ], "project_new_vulnerability_email_type": "...", "project_new_vulnerability_email": "...", "project_new_vulnerability_email_additional_recipients": [ "..." ], "project_forced_emails": [ "..." ], "project_executive_summary": "...", "project_attack_chains": [ { "total": 999 } ], "project_team": [ { "id": "...", "user_id": "...", "first_name": "...", "last_name": "...", "access_level": "...", "role": "...", "email_notifications": [ "..." ], "last_modified": "..." } ], "project_hold_history": [ { "status": "...", "reason": "...", "created": "..." } ], "project_retests_requested": 999, "project_retests_completed": 999, "project_retesting_history: [ { "retesting_round_id": "...", "retesting_round": 1, "retesting_round_status": "...", "retesting_round_actioned_by": { "user_id": "...", "user_first_name": "...", "user_last_name": "..." }, "retesting_round_vulnerabilities": [ { "vulnerability_id": "...", "vulnerability_alternate_id": "...", "vulnerability_title": "..." } ], "retesting_window_end": "...", "retesting_window_start": "...", "retesting_round_retested_vulnerabilities": [ { "vulnerability_id": "...", "vulnerability_alternate_id": "...", "vulnerability_title": "..." } ] } ], "project_streams": [ { "id": "...", "name": "...", "stream_portfolios": [ { "id": "...", "name": "...", } ] } ], "project_total_assets": 999, "project_total_testcases": 999, "project_not_tested_testcases": 999, "project_in_progress_testcases": 999, "project_tested_testcases": 999, "project_not_applicable_testcases": 999, "project_total_vulnerabilities": 999, "project_open_vulnerabilities": 999, "project_closed_vulnerabilities": 999, "project_retest_vulnerabilities": 999, "project_critical_vulnerabilities": 999, "project_critical_open_vulnerabilities": 999, "project_critical_ready_for_retest_vulnerabilities": 999, "project_critical_closed_vulnerabilities": 999, "project_high_vulnerabilities": 999, "project_high_open_vulnerabilities": 999, "project_high_ready_for_retest_vulnerabilities": 999, "project_high_closed_vulnerabilities": 999, "project_medium_vulnerabilities": 999, "project_medium_open_vulnerabilities": 999, "project_medium_ready_for_retest_vulnerabilities": 999, "project_medium_closed_vulnerabilities": 999, "project_low_vulnerabilities": 999, "project_low_open_vulnerabilities": 999, "project_low_ready_for_retest_vulnerabilities": 999, "project_low_closed_vulnerabilities": 999, "project_info_vulnerabilities": 999, "project_info_open_vulnerabilities": 999, "project_info_ready_for_retest_vulnerabilities": 999, "project_info_closed_vulnerabilities": 999, "project_zeroday_vulnerabilities": 999, "project_easily_exploitable_vulnerabilities": 999, "project_cwe_top_25_vulnerabilities": 999, "project_owasp_top_10_vulnerabilities": 999, "project_pending_vulnerabilities": 999, "project_testsuites": [ { "id": "...", "name": "..." } ], "project_created": "...", "project_last_modified": "...", "project_custom_fields": [ { "key": "...", "value": "...", "type": "Tag/Field" } ], "project_reporting_custom_fields": [ { "key": "...", "value": "..." } ], "project_summary_custom_fields": [ { "key": "...", "value": "..." } ], "project_features": { "attack_chains": { "access": { "project_access_level": "...", "roles": [ "..." ] }, "enabled": true }, "reporting": { "access": { "project_access_level": "...", "roles": [ "..." ] }, "enabled": true }, "retesting": { "access": { "project_access_level": "...", "roles": [ "..." ] }, "enabled": true }, "testcases": { "access": { "project_access_level": "...", "roles": [ "..." ] } } }, "project_pages": { "summary": { "access": { "edit_project_access_levels": [ "..." ], "edit_roles": [ "..." ], "upload_project_access_levels": [ "..." ], "upload_roles": [ "..." ], "view_project_access_levels": [ "..." ], "view_roles": [ "..." ] }, "enabled": true, "custom_fields": [ { "key": "...", "value": "...", "type": "Tag/Field" } ] } } } ] } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/getprojectsbygroup.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.