Increase.Groups (Increase v1.0.0)

Copy Markdown View Source

Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth here.

See https://increase.com/documentation/api/groups for the full API reference for this resource.

Summary

Functions

retrieve(client, opts \\ [])

Returns details for the currently authenticated Group.

Functions

retrieve(client, opts \\ [])

@spec retrieve(
  Increase.Client.t() | keyword() | nil,
  keyword()
) :: {:ok, Increase.Groups.Group.t()} | {:error, Increase.Error.t()}

Returns details for the currently authenticated Group.

GET /groups/current