Skip to content

README.md

Latest commit

 

History

History
60 lines (41 loc) · 4.11 KB

README.md

File metadata and controls

60 lines (41 loc) · 4.11 KB

ConnectionConsents

(vault.connection_consents)

Overview

Available Operations

  • list - Get consent records

list

Get all consent records for a connection

Example Usage

from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.vault.connection_consents.list(service_id="pipedrive", unified_api="crm")

    assert res.get_consent_records_response is not None

    # Handle response
    print(res.get_consent_records_response)

Parameters

Parameter Type Required Description Example
service_id str ✔️ Service ID of the resource to return pipedrive
unified_api str ✔️ Unified API crm
consumer_id Optional[str] ➖ ID of the consumer which you want to get or push data from test-consumer
app_id Optional[str] ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.VaultConnectionConsentsAllResponse

Errors

Error Type Status Code Content Type
models.BadRequestResponse 400 application/json
models.UnauthorizedResponse 401 application/json
models.PaymentRequiredResponse 402 application/json
models.NotFoundResponse 404 application/json
models.UnprocessableResponse 422 application/json
models.APIError 4XX, 5XX */*