get_project_list

5min

This call returns project data. The arguments that would be included in the doc are described below:
Basic parameters
Name
Type
Required
Description
action
string
true
get_project_list
group_id
integer
true
This can be any group id within your organization
doc
array
false
See doc parameters below.
Doc Parameters

Name
Type
Required
Description
only_archived
boolean
false
Includes only archived projects.
with_archived
boolean
false
Includes active and archived projects.
﻿
Example
Call
Curl
Python
import requests
import json
projects_endpoint = https://www.regpack.com/reg/api2/projects/
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Api-Id": "15263",
    "Api-user": "[email protected]",
    "Api-Token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
    "action": "get_project_list",
    "group_id": 1625251,
    "doc": {
        "only_archived": False,
        "with_archived": True        }
}
get_project_list_json = json.dumps(payload)
get_project_list_response = requests.post(url=users_endpoint, 
                                              data=get_project_list_json, 
                                              headers=headers, 
                                              timeout=10)
import requests
import json
projects_endpoint = https://www.regpack.com/reg/api2/projects/
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Api-Id": "15263",
    "Api-user": "api_admin@regpacks.com",
    "Api-Token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
    "action": "get_project_list",
    "group_id": 1625251,
    "doc": {
        "only_archived": False,
        "with_archived": True        }
}
get_project_list_json = json.dumps(payload)
get_project_list_response = requests.post(url=users_endpoint, 
                                              data=get_project_list_json, 
                                              headers=headers, 
                                              timeout=10)
﻿
Response
JSON
{'only_archived': False,
 'projects': [{'_excluded': '0',
               'creation_date': '2015-01-28 11:38:54',
               'group_currency': 'USD',
               'group_id': '2514736',
               'group_name': 'Village Vanguard - Outbound Marketing'
               },
              {'_excluded': '0',
               'creation_date': '2022-04-27 14:35:01',
               'group_currency': 'USD',
               'group_id': '1625251',
               'group_name': 'Booking at the Village Vanguard'
               }],
 'success': True,
 'with_archived': False,
 'with_group_totals': True}

{'only_archived': False,
 'projects': [{'_excluded': '0',
               'creation_date': '2015-01-28 11:38:54',
               'group_currency': 'USD',
               'group_id': '2514736',
               'group_name': 'Village Vanguard - Outbound Marketing'
               },
              {'_excluded': '0',
               'creation_date': '2022-04-27 14:35:01',
               'group_currency': 'USD',
               'group_id': '1625251',
               'group_name': 'Booking at the Village Vanguard'
               }],
 'success': True,
 'with_archived': False,
 'with_group_totals': True}
﻿
﻿

Name	Type	Required	Description
action	string	true	get_project_list
group_id	integer	true	This can be any group id within your organization
doc	array	false	See doc parameters below.

Name	Type	Required	Description
only_archived	boolean	false	Includes only archived projects.
with_archived	boolean	false	Includes active and archived projects.

Updated 05 Nov 2024

Did this page help you?

Projects

Webhooks