TeamMemberAPI.md

\TeamMemberAPI

All URIs are relative to https://api.sendx.io/api/v1/rest

Method	HTTP request	Description
GetAllTeamMembers	Get /team/member	Get all team members
GetTeamMember	Get /team/member/{identifier}	Get a team member by ID

GetAllTeamMembers

[]RestRMember GetAllTeamMembers(ctx).Execute()

Get all team members

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sendx/sendx-go-sdk"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamMemberAPI.GetAllTeamMembers(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamMemberAPI.GetAllTeamMembers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetAllTeamMembers`: []RestRMember
	fmt.Fprintf(os.Stdout, "Response from `TeamMemberAPI.GetAllTeamMembers`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetAllTeamMembersRequest struct via the builder pattern

Return type

[]RestRMember

Authorization

TeamApiKey

HTTP request headers

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

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

GetTeamMember

RestRMember GetTeamMember(ctx, identifier).Execute()

Get a team member by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/sendx/sendx-go-sdk"
)

func main() {
	identifier := "contact_BnKjkbBBS500CoBCP0oChQ" // string | Resource identifier with prefix (e.g., `contact_BnKjkbBBS500CoBCP0oChQ`)  **Format:** `<prefix>_<22-character-id>` 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TeamMemberAPI.GetTeamMember(context.Background(), identifier).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TeamMemberAPI.GetTeamMember``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTeamMember`: RestRMember
	fmt.Fprintf(os.Stdout, "Response from `TeamMemberAPI.GetTeamMember`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
identifier	string	Resource identifier with prefix (e.g., `contact_BnKjkbBBS500CoBCP0oChQ`) Format: `<prefix>_<22-character-id>`

Other Parameters

Other parameters are passed through a pointer to a apiGetTeamMemberRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

RestRMember

Authorization

TeamApiKey

HTTP request headers

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

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