TeamMembersApi.md

SignrequestClient.TeamMembersApi

All URIs are relative to https://signrequest.com/api/v1

Method	HTTP request	Description
teamMembersList	GET /team-members/	Retrieve a list of Team Members
teamMembersRead	GET /team-members/{uuid}/	Retrieve a Team Member

teamMembersList

InlineResponse2006 teamMembersList(opts)

Retrieve a list of Team Members

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamMembersApi();

var opts = { 
  'is_active': "is_active_example", // String | 
  'is_owner': "is_owner_example", // String | 
  'is_admin': "is_admin_example", // String | 
  'user__email': "user__email_example", // String | 
  'user__first_name': "user__first_name_example", // String | 
  'user__last_name': "user__last_name_example", // String | 
  'page': 56, // Number | A page number within the paginated result set.
  'limit': 56 // Number | Number of results to return per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamMembersList(opts, callback);

Parameters

Name	Type	Description	Notes
is_active	String		[optional]
is_owner	String		[optional]
is_admin	String		[optional]
user__email	String		[optional]
user__first_name	String		[optional]
user__last_name	String		[optional]
page	Number	A page number within the paginated result set.	[optional]
limit	Number	Number of results to return per page.	[optional]

Return type

InlineResponse2006

Authorization

Token

HTTP request headers

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

teamMembersRead

TeamMember teamMembersRead(uuid)

Retrieve a Team Member

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamMembersApi();

var uuid = "uuid_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamMembersRead(uuid, callback);

Parameters

Name	Type	Description	Notes
uuid	String

Return type

TeamMember

Authorization

Token

HTTP request headers

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