Sha256: e7723432dbc3787b77b486b3d561a3efb193c1adc6d85700c644bf61fea4a2fb

Contents?: true

Size: 1.49 KB

Versions: 6

Compression:

Stored size: 1.49 KB

Contents

# Group Calendlyr::Group

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

Visit official [API Doc](https://developer.calendly.com/api-docs/15c7951a86b40-group)

## Client requests

### Retrieve

Returns information about a specified Group.

Visit official [API Doc](https://developer.calendly.com/api-docs/beaf147a3bc34-get-group)

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

### List

Returns a list of groups.

Visit official [API Doc](https://developer.calendly.com/api-docs/6rb6dtdln74sy-list-groups)

```ruby
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

```ruby
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.

```ruby
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.

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
calendlyr-0.7.5 docs/resources/groups/group.md
calendlyr-0.7.4 docs/resources/groups/group.md
calendlyr-0.7.3 docs/resources/groups/group.md
calendlyr-0.7.2 docs/resources/groups/group.md
calendlyr-0.7.1 docs/resources/groups/group.md
calendlyr-0.7.0 docs/resources/groups/group.md