Projects

4 min

The projects endpoint

POST https://www.regpack.com/reg/api2/projects/

The projects endpoint allows you to return a list of the projects within your organization.

Basic structure

Each call to the API requires action and a group_id.

Name	Type	Required	Description
action	string	true	This describes what you would like to do with the api. For status, the only action is create.
group_id	integer	true	For the projects endpoint, this only needs to be a project within your organization. API-id in the header must be part of the organization that owns the group.
doc	JSON	true	This is the status data you would like to include in the request, formatted as JSON.

Example call

Each call to the API requires action and a group_id.

curl -X POST "https://www.regpack.com/reg/api2/projects/" \ 
     -H "Content-Type: application/json" \ 
     -H "Accept: application/json" \ 
     -H "Api-Id: 15263" \ 
     -H "Api-user: [email protected]" \ 
     -H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \ 
     -d '{
    "action": "get_project_list",
    "group_id": 1625251,
    "doc": {
        "only_archived": false,
        "with_archived": true
    }
}

Example response

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