v1.0.0 to v1.0.0

25 added, 0 removed. Audit A to A.

---
name: microsoft-dynamics
description: |
Microsoft Dynamics CRM integration via Apideck's CRM unified API — same methods work across every connector in CRM, switch by changing `serviceId`. Use when the user wants to read, write, or search contacts, companies, leads, opportunities, activities, and pipelines in Microsoft Dynamics CRM. Routes through Apideck with serviceId "microsoft-dynamics".
license: Apache-2.0
alwaysApply: false
metadata:
author: apideck
version: "1.0.0"
serviceId: microsoft-dynamics
unifiedApis: ["crm"]
authType: oauth2
tier: "1c"
verified: true
+ difficulty: moderate
+ partnershipRequired: false
+ sandboxAvailable: true
---
# Microsoft Dynamics CRM (via Apideck)
Access Microsoft Dynamics CRM through Apideck's **CRM** unified API — one of 21 CRM connectors that share the same method surface. Code you write here ports to Odoo, Salesforce, HubSpot and 17 other CRM connectors by changing a single `serviceId` string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant Microsoft Dynamics CRM plumbing.
## Quick facts
- **Apideck serviceId:** `microsoft-dynamics`
- **Unified API:** CRM
- **Auth type:** oauth2
- **Apideck setup guide:** [Connection guide](https://developers.apideck.com/connectors/microsoft-dynamics/docs/consumer+connection)
- **Gotchas:** [page](https://developers.apideck.com/apis/crm/microsoft-dynamics/gotchas)
- **Microsoft Dynamics CRM docs:** https://learn.microsoft.com/dynamics365/
- **Homepage:** https://dynamics.microsoft.com/en-us/
+
+ ## At a glance
+
+ - **Implementation difficulty:** moderate — Self-Service OAuth + Publisher Verification Required for Cross-Tenant Consent
+ - **Vendor partnership required:** no ([Microsoft Entra publisher verification](https://learn.microsoft.com/en-us/entra/identity-platform/publisher-verification-overview)) — No partnership contract; publisher verification requires a Microsoft AI Cloud Partner Program account.
+ - **Apideck-managed credentials:** available — For testing: the Microsoft consent screen shows "Apideck". Use your own Microsoft Entra app in production.
+ - **Account type required:** Dynamics 365 Sales or Customer Engagement environment (online) with a full user licence
+ - **Consumer access level:** Any licensed user with access to the records; the tenant's consent policy may require an admin to approve the app
+ - **Sandbox:** available ([signup](https://learn.microsoft.com/en-us/dynamics365/sales/sign-up-for-sales-trial)) — 30-day Dynamics 365 Sales trial; sign-up needs a work account and card details.
+ - **Costs:** None. App registration, publisher verification and Dataverse Web API calls are free.
+ - **Rate limits:** 6,000 requests per 5 minutes per user (plus 20 minutes execution time and 52 concurrent requests); HTTP 429 with Retry-After.
+ - **Authentication:** Authorization Code flow through Microsoft Entra ID; the consumer enters their Dynamics 365 organisation URL when connecting.
+ - **Webhooks:** No webhooks — Dynamics 365 changes are not surfaced as Apideck events; sync by polling the CRM and Lead APIs
+
+ **Important to know:**
+
+ - Publisher verification is the hidden gate: since November 2020 Microsoft blocks users in other tenants from consenting to a new multitenant app that is not publisher verified. Plan for it before onboarding, including a publisher domain you own.
+ - A connection covers exactly one Dynamics 365 environment (for example https://yourorg.crm.dynamics.com), so a consumer running several environments needs a separate connection, and a separate authorization, for each one.
+ - There is no free long-lived test environment: Power Apps developer environments cannot install Dynamics 365 apps and the Microsoft 365 developer sandbox is gated to Visual Studio subscribers, partners and support customers. Plan testing around the 30-day trial.
+ - Refresh tokens expire after 90 days without use, so a consumer whose integration sits idle for three months has to re-authorize the connection.
+
+ > Facts synced from Apideck's connector metadata API — `GET /connector/connectors/microsoft-dynamics` (`overview` field) is the live, authoritative version.
## When to use this skill
Activate this skill when the user explicitly wants to work with **Microsoft Dynamics CRM** — for example, "pull contacts in Microsoft Dynamics CRM" or "sync leads in Microsoft Dynamics CRM". This skill teaches the agent:
1. Which Apideck unified API covers Microsoft Dynamics CRM (CRM)
2. The correct `serviceId` to pass on every call (`microsoft-dynamics`)
3. Microsoft Dynamics CRM-specific auth and coverage caveats
For the full method surface (parameters, pagination, filtering), use your language SDK skill:
- [`apideck-node`](../../skills/apideck-node/), [`apideck-python`](../../skills/apideck-python/), [`apideck-dotnet`](../../skills/apideck-dotnet/), [`apideck-java`](../../skills/apideck-java/), [`apideck-go`](../../skills/apideck-go/), [`apideck-php`](../../skills/apideck-php/), or [`apideck-rest`](../../skills/apideck-rest/)
For the raw OpenAPI spec:
- **CRM:** [https://specs.apideck.com/crm.yml](https://specs.apideck.com/crm.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=crm)
## Minimal example (TypeScript)
```typescript
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env.APIDECK_API_KEY,
appId: process.env.APIDECK_APP_ID,
consumerId: "your-consumer-id",
});
// List contacts in Microsoft Dynamics CRM
const { data } = await apideck.crm.contacts.list({
serviceId: "microsoft-dynamics",
});
```
## Portable across 21 CRM connectors
The Apideck **CRM** unified API exposes the same methods for every connector in its catalog. Switching from Microsoft Dynamics CRM to another CRM connector is a one-string change — no rewrite, no new SDK.
```typescript
// Today — Microsoft Dynamics CRM
await apideck.crm.contacts.list({ serviceId: "microsoft-dynamics" });
// Tomorrow — same code, different connector
await apideck.crm.contacts.list({ serviceId: "odoo" });
await apideck.crm.contacts.list({ serviceId: "salesforce" });
```
This is the compounding advantage of using Apideck over integrating Microsoft Dynamics CRM directly: code against the unified CRM API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.
## Authentication
- **Type:** OAuth 2.0
- **Managed by:** Apideck Vault — Apideck handles the full OAuth dance (authorization code flow, token exchange, refresh). Never ask the user for API keys or tokens directly.
- **User setup:** Users authorize via the Vault modal. Connection state progresses `available → added → authorized → callable`.
- **Token refresh:** automatic. Expired tokens are refreshed transparently on the next API call.
**Setup guide:** Apideck publishes a step-by-step guide for registering an OAuth app / configuring credentials for Microsoft Dynamics CRM — see [https://developers.apideck.com/connectors/microsoft-dynamics/docs/consumer+connection](https://developers.apideck.com/connectors/microsoft-dynamics/docs/consumer+connection). Use that as the authoritative source when walking users through connection setup.
See [`apideck-best-practices`](../../skills/apideck-best-practices/) for Vault setup, connection lifecycle, and handling re-auth flows.
## Verifying coverage
Not every CRM operation is supported by every connector. Always verify before assuming a method works:
```bash
curl 'https://unify.apideck.com/connector/connectors/microsoft-dynamics' \
-H "Authorization: Bearer ${APIDECK_API_KEY}" \
-H "x-apideck-app-id: ${APIDECK_APP_ID}"
```
See [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) for patterns around `UnsupportedOperationError` and connector-specific fallbacks.
## Escape hatch: Proxy API
When an endpoint isn't covered by the CRM unified API, use Apideck's Proxy to call Microsoft Dynamics CRM directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on Microsoft Dynamics CRM's own API:
```bash
curl 'https://unify.apideck.com/proxy' \
-H "Authorization: Bearer ${APIDECK_API_KEY}" \
-H "x-apideck-app-id: ${APIDECK_APP_ID}" \
-H "x-apideck-consumer-id: ${CONSUMER_ID}" \
-H "x-apideck-service-id: microsoft-dynamics" \
-H "x-apideck-downstream-url: <target endpoint on Microsoft Dynamics CRM>" \
-H "x-apideck-downstream-method: GET"
```
See [Microsoft Dynamics CRM's API docs](https://learn.microsoft.com/dynamics365/) for available endpoints.
## Sibling connectors
Other **CRM** connectors that share this unified API surface (same method signatures, just change `serviceId`):
[`odoo`](../odoo/) *(beta)*, [`salesforce`](../salesforce/), [`hubspot`](../hubspot/), [`pipedrive`](../pipedrive/), [`zoho-crm`](../zoho-crm/), [`activecampaign`](../activecampaign/), [`close`](../close/), [`teamleader`](../teamleader/), and 12 more.
## See also
- [Apideck connection guide for Microsoft Dynamics CRM](https://developers.apideck.com/connectors/microsoft-dynamics/docs/consumer+connection)
- [CRM OpenAPI spec](https://specs.apideck.com/crm.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=crm)
- [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) — programmatic coverage checks
- [`apideck-best-practices`](../../skills/apideck-best-practices/) — architecture, Vault, pagination, error handling
- [`apideck-node`](../../skills/apideck-node/) — TypeScript / Node SDK patterns
- [Microsoft Dynamics CRM official docs](https://learn.microsoft.com/dynamics365/)