## List users for a sub-organization.

**get** `/print-mail/v1/sub_organizations/{id}/users`

List users for a sub-organization.

### Path Parameters

- `id: string`

### 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

- `id: string`

  A unique ID prefixed with `user_`.

- `email: string`

  The email of the user.

- `name: string`

  The name of the user.

- `organization: string`

  A unique ID prefixed with `user_`.

- `pendingInvite: boolean`

  Indicates if the user has a pending invite.

- `roles: array of string`

  The roles given to the user. Roles can be used to restrict access for
  users.

- `verifiedEmail: boolean`

  Indicates if the user has a verified email or not.

- `emailPreferences: optional EmailPreferences`

  A set of preferences for how a user should receive emails.

  - `orderPreviewSendPreference: optional "do_not_send" or "send_live_only" or "send_live_and_test"`

    The list of preferences for receiving order preview emails.

    - `"do_not_send"`

    - `"send_live_only"`

    - `"send_live_and_test"`

- `lastLoginTime: optional string`

  The date and time at which the user last logged in.

- `phoneNumber: optional string`

  The phone number of the user.

- `previousEmails: optional array of string`

  A list of emails the user has previously had. If a user has changed their
  email before, this list will be populated with all of the emails they
  once had.

### Example

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

#### Response

```json
[
  {
    "id": "user_abc123def456ghi6789",
    "pendingInvite": false,
    "organization": "org_abc123def456ghi6789",
    "email": "user@postgrid.com",
    "name": "Calvin",
    "verifiedEmail": true,
    "roles": [
      "role_abc123def456ghi6789"
    ]
  }
]
```