## List sub-organizations.

**get** `/print-mail/v1/sub_organizations`

List sub-organizations.

### Query Parameters

- `limit: optional number`

- `search: optional string`

  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 number`

### Returns

- `data: array of SubOrganization`

  - `id: string`

    A unique ID prefixed with `sub_org_`.

  - `countryCode: string`

    The country code of the sub-organization.

  - `createdAt: string`

    The UTC time at which this resource was created.

  - `limit: number`

    The limit of mailings the sub-organization can send before being charged
    overages for the month.

  - `name: string`

    The name of the sub-organization.

  - `object: "sub_org"`

    Always `sub_org`.

    - `"sub_org"`

  - `spend: number`

    The current rolling charge for the sub-organization for the month, in
    cents.

  - `updatedAt: string`

    The UTC time at which this resource was last update.

  - `usage: number`

    The amount of mail the sub-organization has sent out this month.

- `limit: number`

- `object: "list"`

  - `"list"`

- `skip: number`

- `totalCount: number`

### Example

```http
curl https://api.postgrid.com/print-mail/v1/sub_organizations \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"
```

#### 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"
    }
  ]
}
```