list_projects

imerit_ango.sdk.SDK.

list_projects(page, limit)

Retrieve all projects in your organization.

Parameters

• page: int, default 1

  • Current page.

  • Example: 1

• limit: int, default 10, maximum 1000

  • Number of projects per page.

  • Example: 100

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Including a status field indicating whether the request was successful and a data field containing the response payload with updated resources produced by the operation.

Example

List the first ten projects from the organization:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

sdk_response = ango_sdk.list_projects()
project_list = sdk_response['data']['projects']

print(project_list[0])

curl

List all projects from the organization:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

page = 1
num_projects = 1
project_list = []
while len(project_list) < num_projects:
    response = ango_sdk.list_projects(page=page, limit=50)
    projects = response.get('data', {}).get('projects', [])
    num_projects = response.get('data', {}).get('total', 0)

    project_list.extend(projects)
    page += 1

print("The number of retrieved projects is: " + str(len(project_list)))

See also

create_project, get_project