Skip to content

MembersApi.md

Latest commit

 

History

History
261 lines (187 loc) · 7.79 KB

MembersApi.md

File metadata and controls

261 lines (187 loc) · 7.79 KB

pandadoc_client.MembersApi

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

Method HTTP request Description
details_current_member GET /public/v1/members/current Current member details
details_member GET /public/v1/members/{id} Member details
list_members GET /public/v1/members List members

details_current_member

MemberDetailsResponse details_current_member()

Current member details

A method to define to whom credentials belong

Example

  • Api Key Authentication (apiKey):
  • OAuth Authentication (oauth2):
import pandadoc_client
from pandadoc_client.api import members_api
from pandadoc_client.model.member_details_response import MemberDetailsResponse
from pprint import pprint

# Defining the host is optional and defaults to https://api.pandadoc.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pandadoc_client.Configuration(
    host="https://api.pandadoc.com",
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
configuration.api_key_prefix['apiKey'] = 'API-Key'

# Configure OAuth2 access token for authorization: oauth2
# configuration = pandadoc_client.Configuration(
#    host="https://api.pandadoc.com",
# )
# configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pandadoc_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = members_api.MembersApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Current member details
        api_response = api_instance.details_current_member()
        pprint(api_response)
    except pandadoc_client.ApiException as e:
        print("Exception when calling MembersApi->details_current_member: %s\n" % e)

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]

details_member

MemberDetailsResponse details_member(id)

Member details

A method to retrieve a member's details by id

Example

  • Api Key Authentication (apiKey):
  • OAuth Authentication (oauth2):
import pandadoc_client
from pandadoc_client.api import members_api
from pandadoc_client.model.member_details_response import MemberDetailsResponse
from pprint import pprint

# Defining the host is optional and defaults to https://api.pandadoc.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pandadoc_client.Configuration(
    host="https://api.pandadoc.com",
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
configuration.api_key_prefix['apiKey'] = 'API-Key'

# Configure OAuth2 access token for authorization: oauth2
# configuration = pandadoc_client.Configuration(
#    host="https://api.pandadoc.com",
# )
# configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pandadoc_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = members_api.MembersApi(api_client)
    id = "radQBiBkU7MBk59NSgaGf5"  # str | Membership id

    # example passing only required values which don't have defaults set
    try:
        # Member details
        api_response = api_instance.details_member(id)
        pprint(api_response)
    except pandadoc_client.ApiException as e:
        print("Exception when calling MembersApi->details_member: %s\n" % e)

Parameters

Name Type Description Notes
id str Membership id

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]

list_members

MemberListResponse list_members()

List members

Retrieve all members details of the workspace

Example

  • Api Key Authentication (apiKey):
  • OAuth Authentication (oauth2):
import pandadoc_client
from pandadoc_client.api import members_api
from pandadoc_client.model.member_list_response import MemberListResponse
from pprint import pprint

# Defining the host is optional and defaults to https://api.pandadoc.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pandadoc_client.Configuration(
    host="https://api.pandadoc.com",
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
configuration.api_key_prefix['apiKey'] = 'API-Key'

# Configure OAuth2 access token for authorization: oauth2
# configuration = pandadoc_client.Configuration(
#    host="https://api.pandadoc.com",
# )
# configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with pandadoc_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = members_api.MembersApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # List members
        api_response = api_instance.list_members()
        pprint(api_response)
    except pandadoc_client.ApiException as e:
        print("Exception when calling MembersApi->list_members: %s\n" % e)

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]