Skip to content

README.md

Latest commit

 

History

History
60 lines (41 loc) · 4.09 KB

README.md

File metadata and controls

60 lines (41 loc) · 4.09 KB

CustomMappings

(vault.custom_mappings)

Overview

Available Operations

  • list - List custom mappings

list

This endpoint returns a list of custom mappings.

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.custom_mappings.list(unified_api="crm", service_id="pipedrive")

    assert res.get_custom_mappings_response is not None

    # Handle response
    print(res.get_custom_mappings_response)

Parameters

Parameter Type Required Description Example
unified_api str ✔️ Unified API crm
service_id str ✔️ Service ID of the resource to return pipedrive
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.VaultCustomMappingsAllResponse

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 */*