List sub-organizations.

GET/print-mail/v1/sub_organizations

Query ParametersExpand Collapse

limit: optional number

formatint32

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

formatint32

ReturnsExpand Collapse

data: array of SubOrganization { id, countryCode, createdAt, 6 more }

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.

formatdate-time

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.

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.

formatdate-time

usage: number

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

limit: number

formatint32

object: "list"

skip: number

formatint32

totalCount: number

formatint32