Skip to content

TeamMemberApi.md

Latest commit

 

History

History
106 lines (67 loc) · 2.73 KB

TeamMemberApi.md

File metadata and controls

106 lines (67 loc) · 2.73 KB
Raw

sendx.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()

Get all team members

Retrieves all team members.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.TeamMemberApi();
apiInstance.getAllTeamMembers().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

[RestRMember]

Authorization

TeamApiKey

HTTP request headers

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

getTeamMember

RestRMember getTeamMember(identifier)

Get a team member by ID

Retrieves a single team member by their unique identifier.

Example

import sendx from 'sendx-javascript-sdk';
let defaultClient = sendx.ApiClient.instance;
// Configure API key authorization: TeamApiKey
let TeamApiKey = defaultClient.authentications['TeamApiKey'];
TeamApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//TeamApiKey.apiKeyPrefix = 'Token';

let apiInstance = new sendx.TeamMemberApi();
let identifier = "contact_BnKjkbBBS500CoBCP0oChQ"; // String | Resource identifier with prefix (e.g., `contact_BnKjkbBBS500CoBCP0oChQ`)  **Format:** `<prefix>_<22-character-id>` 
apiInstance.getTeamMember(identifier).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String Resource identifier with prefix (e.g., `contact_BnKjkbBBS500CoBCP0oChQ`) Format: `<prefix>_<22-character-id>`

Return type

RestRMember

Authorization

TeamApiKey

HTTP request headers

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