Getting Started

You can send your Zoho CRM GraphQL API query using the below end point.

GraphQL URL

{api-domain}/crm/graphql

Use the domain specific API url for {api-domain}.

Method

POST

Required Scopes

ZohoCRM.graphql.READ (and) Scope of the corresponding resource

Prerequisites

Zoho CRM Ultimate Edition.
GraphQL must be enabled in prior, for the user's profile through Enable GraphQL API.
Know the GraphQL schema using the introspection query.

To try out GraphQL in Postman application, you can use Postman's GraphQL client.

postman graphql

To send GraphQL queries using the Postman GraphQL Client, follow these steps:

Select New > GraphQL. Enter the CRM GraphQL endpoint URL in the URL field.
In the Authorization tab, provide necessary authorization.
In the Query tab, click on the use GraphQL Introspection. You can now use it to view the resources available to you and construct the query. Alternatively, you can also type your query directly in the Query editor.
Execute the request by clicking the Query button.

You can use this sample query

Copiedquery {
    Meta {
        Modules(filter: { api_name: "Leads" }) {
            _data {
                plural_label
                presence_sub_menu
                id
                properties
                visibility
                on_demand_properties
                web_link
                api_name
                module_name
                description
                modified_time
                show_as_tab
                sequence_number
                singular_label
                api_supported
                generated_type
                feeds_required
                business_card_field_limit
                status
            }
        }
    }
}

Response

Copied{
    "data": {
        "Meta": {
            "Modules": {
                "_data": [
                    {
                        "plural_label": "Leads",
                        "presence_sub_menu": true,
                        "id": "5843104000000002175",
                        "properties": [
                            "$approval_state",
                            "$wizard_connection_path",
                            "$converted_detail",
                            "$cpq_executions",
                            "$currency_symbol",
                            "$zia_owner_assignment",
                            "$review",
                            "$review_process",
                            "$approval",
                            "$in_merge",
                            "$process_flow",
                            "$orchestration",
                            "$pathfinder",
                            "$zia_visions",
                            "$editable",
                            "$field_states",
                            "$locked_for_me",
                            "$has_more",
                            "$sharing_permission"
                        ],
                        "visibility": 1,
                        "on_demand_properties": [
                            "$blocked_reason",
                            "$client_portal_invited"
                        ],
                        "web_link": null,
                        "api_name": "Leads",
                        "module_name": "Leads",
                        "description": null,
                        "modified_time": "2024-01-30T20:10:39+05:30",
                        "show_as_tab": true,
                        "sequence_number": 2,
                        "singular_label": "Lead",
                        "api_supported": true,
                        "generated_type": "default",
                        "feeds_required": false,
                        "business_card_field_limit": 5,
                        "status": "visible"
                    }
                ]
            }
        }
    }
}

Each introspection query consumes one credit.

If you cannot find GraphQL client in your Postman try updating Postman to the latest version. Alternatively, you can also make GraphQL requests using Postman's regular request interface. To learn more, see Make an HTTP call with GraphQL.