## List sub-organizations. `print_mail.sub_organizations.list(SubOrganizationListParams**kwargs) -> SyncSkipLimit[SubOrganization]` **get** `/print-mail/v1/sub_organizations` List sub-organizations. ### Parameters - `limit: Optional[int]` - `search: Optional[str]` You can supply any string to help narrow down the list of resources. For example, if you pass `"New York"` (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on `StructuredSearchQuery` for more details. - `skip: Optional[int]` ### Returns - `class SubOrganization: …` The Sub-Organization object. - `id: str` A unique ID prefixed with `sub_org_`. - `country_code: str` The country code of the sub-organization. - `created_at: datetime` The UTC time at which this resource was created. - `limit: int` The limit of mailings the sub-organization can send before being charged overages for the month. - `name: str` The name of the sub-organization. - `object: Literal["sub_org"]` Always `sub_org`. - `"sub_org"` - `spend: int` The current rolling charge for the sub-organization for the month, in cents. - `updated_at: datetime` The UTC time at which this resource was last update. - `usage: int` The amount of mail the sub-organization has sent out this month. ### Example ```python import os from postgrid import PostGrid client = PostGrid( print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"), # This is the default and can be omitted ) page = client.print_mail.sub_organizations.list() page = page.data[0] print(page.id) ``` #### Response ```json { "object": "list", "limit": 10, "skip": 0, "totalCount": 1, "data": [ { "usage": 0, "limit": 500, "spend": 0, "name": "PostGrid", "countryCode": "CA", "id": "sub_org_abc123def456ghi6789", "object": "sub_org", "createdAt": "2020-11-12T23:23:47.974Z", "updatedAt": "2020-11-12T23:23:47.974Z" } ] } ```