Skip to content

Latest commit

 

History

History
182 lines (117 loc) · 4.42 KB

MembersApi.md

File metadata and controls

182 lines (117 loc) · 4.42 KB

.MembersApi

All URIs are relative to https://api.pandadoc.com

Method HTTP request Description
detailsCurrentMember GET /public/v1/members/current Current member details
detailsMember GET /public/v1/members/{id} Member details
listMembers GET /public/v1/members List members

detailsCurrentMember

MemberDetailsResponse detailsCurrentMember()

A method to define to whom credentials belong

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.MembersApi(configuration);

let body:any = {};

apiInstance.detailsCurrentMember(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

MemberDetailsResponse

Authorization

apiKey, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Bad Request -
403 Authentication error -
429 Too Many Requests -

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

detailsMember

MemberDetailsResponse detailsMember()

A method to retrieve a member's details by id

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.MembersApi(configuration);

const body:pd_api.MembersApiDetailsMemberRequest = {
  // string | Membership id
  id: "radQBiBkU7MBk59NSgaGf5",
};

apiInstance.detailsMember(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

Name Type Description Notes
id [string] Membership id defaults to undefined

Return type

MemberDetailsResponse

Authorization

apiKey, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Bad Request -
403 Authentication error -
429 Too Many Requests -

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

listMembers

MemberListResponse listMembers()

Retrieve all members details of the workspace

Example

import * as pd_api from 'pandadoc-node-client';

// replace it with your API key
const API_KEY = "YOUR_API_KEY";
const configuration = pd_api.createConfiguration(
    { authMethods: {apiKey: `API-Key ${API_KEY}`} }
);
const apiInstance = new pd_api.MembersApi(configuration);

let body:any = {};

apiInstance.listMembers(body).then((data) => {
  console.log('API called successfully. Returned data: %o', data);
}).catch((error) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

MemberListResponse

Authorization

apiKey, oauth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Bad Request -
403 Authentication error -
429 Too Many Requests -

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