Manage your organization profile, team members, and account-level settings.
Summary
Functions
List Organizations
Returns all organizations the authenticated user belongs to.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.params— Optional map of query parameters:"cursor"— Optional query parameter, string. Pagination cursor from a previous response"limit"— Optional query parameter, integer. Maximum number of items to return Defaults to30.
opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Organizations.list_organizations(
client,
%{
"cursor" => "cursor",
"limit" => 30
}
)Retrieve Organization
Returns the organization's profile, plan, region, and account status.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.id— Required path parameter, string. The id of the organizationopts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Organizations.retrieve_organization(client, "id")Retrieve Organization Usage
Returns current period usage metrics (daily and monthly) for sending and receiving, against your plan limits.
Arguments
client— ANuntly.Clientreturned byNuntly.new/1.id— Required path parameter, string.opts— Optional keyword list passed to Req for this request.
Example
client = Nuntly.new(api_key: "ntly_...")
Nuntly.Organizations.retrieve_organization_usage(client, "id")