SubteamMembersApi.md

WhatpulseSdk::SubteamMembersApi

All URIs are relative to https://whatpulse.test/api/v1

Method	HTTP request	Description
v1_teams_subteams_members	GET /teams/{team_id}/subteams/{subteam_id}/members	Get subteam members

v1_teams_subteams_members

v1_teams_subteams_members(team_id, subteam_id, opts)

Get subteam members

Get a paginated list of users that are members of a specific subteam.

Examples

require 'time'
require 'whatpulse-sdk'
# setup authorization
WhatpulseSdk.configure do |config|
  # Configure Bearer authorization: http
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = WhatpulseSdk::SubteamMembersApi.new
team_id = 'team_id_example' # String | Team ID, name or slug
subteam_id = 56 # Integer | Subteam ID
opts = {
  per_page: 56 # Integer | 
}

begin
  # Get subteam members
  result = api_instance.v1_teams_subteams_members(team_id, subteam_id, opts)
  p result
rescue WhatpulseSdk::ApiError => e
  puts "Error when calling SubteamMembersApi->v1_teams_subteams_members: #{e}"
end

Using the v1_teams_subteams_members_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_teams_subteams_members_with_http_info(team_id, subteam_id, opts)

begin
  # Get subteam members
  data, status_code, headers = api_instance.v1_teams_subteams_members_with_http_info(team_id, subteam_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <V1TeamsSubteamsMembers200Response>
rescue WhatpulseSdk::ApiError => e
  puts "Error when calling SubteamMembersApi->v1_teams_subteams_members_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
team_id	String	Team ID, name or slug
subteam_id	Integer	Subteam ID
per_page	Integer		[optional]

Return type

V1TeamsSubteamsMembers200Response

Authorization

http

HTTP request headers

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