How to get possible dependency mappings in Zoho Desk

Retrieving possible dependency mappings in Zoho Desk is straightforward via a single GET request to the available mappings endpoint, giving you a list of field relationships you can use when building or auditing layouts.

Why this matters

Dependency mappings in Zoho Desk control how one field's options are filtered based on the value of another field — for example, restricting a sub-category picklist based on a selected category. Before creating or modifying these relationships, you need to know which mappings are already supported by the platform. This discovery step prevents configuration errors and helps developers plan automation or integration logic around valid field pairs.

Step-by-step

Step 1. Confirm your OAuth token includes the correct Zoho Desk settings scope. The scope required for reading configuration data is Desk.settings.READ (or the broader Desk.settings.ALL). Without this, the API will reject your request. ^[7]

Step 2. Send a GET request to the following Zoho Desk API endpoint:

GET /api/v1/availableDependencyMappings

This operation — internally identified as getpossibledependency_mappings — returns the full set of dependency mappings that Zoho Desk considers valid for your organisation. ^[1]

Step 3. Pass any required query parameters as a dictionary via the p argument. The endpoint accepts a p parameter object, so if your integration layer or SDK wraps the call, supply filtering or pagination options there. A minimal Python call looks like this:

result = client.get_possible_dependency_mappings(p={"orgId": "<your-org-id>"})

The method issues a GET to /api/v1/availableDependencyMappings and returns the parsed response. ^[1]

Step 4. Review the response payload. Each entry in the returned list describes a valid pairing of fields that can be linked through a dependency rule. Note the field identifiers — you will need them if you subsequently call the layout dependency listing endpoint (GET /api/v1/dependencyMappings) to see which of these possible mappings are already active in a specific layout. ^[2]

Step 5. If you want to act on the results and create a new mapping, use the POST /api/v1/dependencyMappings endpoint, supplying the field pair details in the request body. Only pairings returned by the availableDependencyMappings call are guaranteed to be accepted. ^[4]

Step 6. This operation is classified as SAFE (read-only, no data mutation), so it is appropriate to call it in diagnostic scripts, health checks, or pre-deployment validation pipelines without risk of side effects. ^[5]

Common pitfalls

• Missing settings scope. The most common reason for a 401 or 403 response is an OAuth token that was generated without Desk.settings.READ. Regenerate the token with the full settings scope group included. ^[7]
• Confusing the two GET endpoints. GET /api/v1/availableDependencyMappings tells you what *could* be mapped; GET /api/v1/dependencyMappings tells you what *is already* mapped in a layout. Using the wrong one leads to incomplete or misleading results. ^[1][2]
• No p parameter provided. While the p dictionary is optional in the method signature, some environments require at least an orgId or department filter to scope the response correctly. If you receive an unexpectedly empty list, try adding explicit organisation context to the query parameters. ^[1]

What to check

• Scope verification: Confirm the active OAuth token contains Desk.settings.READ or Desk.settings.ALL before making the call. ^[7]
• Response completeness: Cross-reference the returned mappings against your layout's existing dependency rules (via GET /api/v1/dependencyMappings) to identify gaps or unused possibilities. ^[2]
• Endpoint URL accuracy: Ensure your base URL matches your data centre (e.g., desk.zoho.com for the US, desk.zoho.eu for Europe) so requests are not silently redirected or dropped. ^[6]

---

*Beam Help provides independent expert support for Zoho products and is not official Zoho support. Always validate API behaviour against your specific Zoho Desk plan and region.*