group.md

Group Calendlyr::Group

The Group resource that was requested. Represents groupings of Users within an Organization.

Visit official API Doc

Client requests

Retrieve

Returns information about a specified Group.

Visit official API Doc

client.groups.retrieve(uuid: uuid)
#=> #<Calendlyr::Group>

List

Returns a list of groups.

Visit official API Doc

client.groups.list(organization: organization_uri)
#=> #<Calendlyr::Collection @data=[#<Calendlyr::Group>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>

Object methods

Associated Organization

group.associated_organization
#=> #<Calendlyr::Organization>

Events

For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.

group.events
#=> #<Calendlyr::Collection @data=[#<Calendlyr::Event>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>

Group Relationships

For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.

group.group_relationships
#=> #<Calendlyr::Collection @data=[#<Calendlyr::Groups::Relationship>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>