Lettermint.Types.ListTeamMembersQuery (Lettermint v2.0.0)

Copy Markdown View Source

Query parameters of GET /team/members (listTeamMembers).

Pass them as a map with nested maps for bracketed names: %{page: %{size: 10}} is sent as page[size]=10. Lists of values are joined with commas, lists of maps are indexed and booleans are sent as 1 or 0.

Parameters

  • page[size] (optional): The number of results that will be returned per page.
  • page[cursor] (optional): The cursor to start the pagination from.

Summary

Functions

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:page) => %{
    optional(:size) => integer(),
    optional(:cursor) => String.t()
  }
}

Functions

__params__()

The wire names of the parameters with their decode specs.