github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/CommunitiesApi.md (about)

     1  # \CommunitiesApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllCommunities**](CommunitiesApi.md#GetAllCommunities) | **Get** /communities | Getting all communities
     8  [**GetCommunity**](CommunitiesApi.md#GetCommunity) | **Get** /communities/{communityId} | Getting a community from its id
     9  
    10  
    11  
    12  ## GetAllCommunities
    13  
    14  > GetAllCommunitiesResponse GetAllCommunities(ctx, optional)
    15  Getting all communities
    16  
    17  This method renders communities ordered by creation date (ascending).
    18  
    19  ### Required Parameters
    20  
    21  
    22  Name | Type | Description  | Notes
    23  ------------- | ------------- | ------------- | -------------
    24  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    25   **optional** | ***GetAllCommunitiesOpts** | optional parameters | nil if no parameters
    26  
    27  ### Optional Parameters
    28  
    29  Optional parameters are passed through a pointer to a GetAllCommunitiesOpts struct
    30  
    31  
    32  Name | Type | Description  | Notes
    33  ------------- | ------------- | ------------- | -------------
    34   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    35   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    36  
    37  ### Return type
    38  
    39  [**GetAllCommunitiesResponse**](GetAllCommunitiesResponse.md)
    40  
    41  ### Authorization
    42  
    43  No authorization required
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## GetCommunity
    56  
    57  > Community GetCommunity(ctx, communityId)
    58  Getting a community from its id
    59  
    60  This method renders a community from given id.
    61  
    62  ### Required Parameters
    63  
    64  
    65  Name | Type | Description  | Notes
    66  ------------- | ------------- | ------------- | -------------
    67  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    68  **communityId** | **string**|  | 
    69  
    70  ### Return type
    71  
    72  [**Community**](Community.md)
    73  
    74  ### Authorization
    75  
    76  No authorization required
    77  
    78  ### HTTP request headers
    79  
    80  - **Content-Type**: Not defined
    81  - **Accept**: application/json
    82  
    83  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    84  [[Back to Model list]](../README.md#documentation-for-models)
    85  [[Back to README]](../README.md)
    86