Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 5.81 KB

LinkedAccountsApi.md

File metadata and controls

107 lines (80 loc) · 5.81 KB
Raw

MergeATSClient.LinkedAccountsApi

All URIs are relative to https://api.merge.dev/api/ats/v1

Method HTTP request Description
linked_accounts_list GET /linked-accounts

linked_accounts_list

PaginatedAccountDetailsAndActionsList linked_accounts_list()

List linked accounts for your organization.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import linked_accounts_api
from MergeATSClient.model.paginated_account_details_and_actions_list import PaginatedAccountDetailsAndActionsList
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/v1"
)

# 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: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = linked_accounts_api.LinkedAccountsApi(api_client)
    category = "accounting" # str, none_type |  (optional)
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    end_user_email_address = "end_user_email_address_example" # str | If provided, will only return linked accounts associated with the given email address. (optional)
    end_user_organization_name = "end_user_organization_name_example" # str | If provided, will only return linked accounts associated with the given organization name. (optional)
    end_user_origin_id = "end_user_origin_id_example" # str | If provided, will only return linked accounts associated with the given origin ID. (optional)
    end_user_origin_ids = "end_user_origin_ids_example" # str | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. (optional)
    id = "id_example" # str |  (optional)
    ids = "ids_example" # str | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. (optional)
    integration_name = "integration_name_example" # str | If provided, will only return linked accounts associated with the given integration name. (optional)
    is_test_account = "is_test_account_example" # str | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    status = "status_example" # str | Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED` (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.linked_accounts_list(category=category, cursor=cursor, end_user_email_address=end_user_email_address, end_user_organization_name=end_user_organization_name, end_user_origin_id=end_user_origin_id, end_user_origin_ids=end_user_origin_ids, id=id, ids=ids, integration_name=integration_name, is_test_account=is_test_account, page_size=page_size, status=status)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling LinkedAccountsApi->linked_accounts_list: %s\n" % e)

Parameters

Name Type Description Notes
category str, none_type [optional]
cursor str The pagination cursor value. [optional]
end_user_email_address str If provided, will only return linked accounts associated with the given email address. [optional]
end_user_organization_name str If provided, will only return linked accounts associated with the given organization name. [optional]
end_user_origin_id str If provided, will only return linked accounts associated with the given origin ID. [optional]
end_user_origin_ids str Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. [optional]
id str [optional]
ids str Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. [optional]
integration_name str If provided, will only return linked accounts associated with the given integration name. [optional]
is_test_account str If included, will only include test linked accounts. If not included, will only include non-test linked accounts. [optional]
page_size int Number of results to return per page. [optional]
status str Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED` [optional]

Return type

PaginatedAccountDetailsAndActionsList

Authorization

tokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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