v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Sub-Organizations

List users for a sub-organization.

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

Path parameters

idstring required

Query parameters

skipinteger

limitinteger

string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

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.

Response

The request has succeeded.

idstring required

A unique ID prefixed with user_.

organizationstring required

A unique ID prefixed with user_.

pendingInviteboolean required

Indicates if the user has a pending invite.

emailstring required

The email of the user.

namestring required

The name of the user.

phoneNumberstring

The phone number of the user.

lastLoginTimestring date-time

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

verifiedEmailboolean required

Indicates if the user has a verified email or not.

rolesstring[] required

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

previousEmailsstring[]

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.