Get Users in Tenant

Returns the users belonging to a tenant with cursor paging. Use it to see who a tenant-scoped send will reach.

get/tenants/{tenant_id}/users

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/tenants/:tenant_id/users/get.ts
A function with typed inputs. Its response is checked against the schema.

tenant_idstring required

Id of the tenant for user membership.

limitinteger nullable

The number of accounts to return (defaults to 20, maximum value of 100)

cursorstring nullable

Continue the pagination with the next cursor

has_moreboolean required

Set to true when there are more pages that can be retrieved.

urlstring required

A url that may be used to generate these results.

next_urlstring nullable

A url that may be used to generate fetch the next set of results. Defined only when has_more is set to true

cursorstring nullable

A pointer to the next page of results. Defined only when has_more is set to true

type'list' required

Always set to list. Represents the type of this object.

No recorded changes to this operation across all 55 revisions of this API.