Skip to content

Latest commit

 

History

History
86 lines (50 loc) · 2.43 KB

CommunitiesApi.md

File metadata and controls

86 lines (50 loc) · 2.43 KB

\CommunitiesApi

All URIs are relative to https://DOMAIN.api.engagement.dimelo.com/1.0

Method HTTP request Description
GetAllCommunities Get /communities Getting all communities
GetCommunity Get /communities/{communityId} Getting a community from its id

GetAllCommunities

GetAllCommunitiesResponse GetAllCommunities(ctx, optional) Getting all communities

This method renders communities ordered by creation date (ascending).

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllCommunitiesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllCommunitiesOpts struct

Name Type Description Notes
offset optional.Int32 The record index to start. Default value is 0.
limit optional.Int32 The max number of records to return. Default value is 30, max value is 150.

Return type

GetAllCommunitiesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCommunity

Community GetCommunity(ctx, communityId) Getting a community from its id

This method renders a community from given id.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
communityId string

Return type

Community

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]