Lettermint.Types.ListTeamMembersQuery (Lettermint v2.2.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.
  • filter[project_id] (optional): Only members who can access this project: members with access to all projects and members selected for it. An unknown project returns an empty list.

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()
  },
  optional(:filter) => %{optional(:project_id) => String.t()}
}

Functions

__params__()

The wire names of the parameters with their decode specs.