Get a Specific Blueprint

GET Blueprints

Purpose

To get the details of a single Blueprint in your Zoho CRM organization.

Endpoints

GET /settings/blueprints/{blueprint_ID}

Request Details

Request URL

{api-domain}/crm/{version}/settings/blueprints/{blueprint_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.blueprint.ALL
(or)
ZohoCRM.settings.blueprint.READ

Parameters

includestring, optional
To include the fields on demand.
Possible values: state, transition.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/blueprints/5843104000008502299"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Request JSON

The Blueprints JSON array is the root element within which the details of the blueprint is present. The Blueprints JSON array includes the following keys:

ownersJSON array
Represents the details of the blueprint owners. This setting can be used to define which users, roles, groups, record owners, or portal user types are associated with or allowed access to the blueprint.
Conditional requirement: This field is mandatory when continuous is set to true.
- resourcesJSON array
  Represents the resource details of the blueprint owner. Each resource identifies an entity such as a user, role, or group associated with the selected owner type.
  - idstring
    Represents the ID of the blueprint owner resource.
- typestring
  Represents the owner type.
  Possible values: users, role, group, record_owner, portal_user_type.
  This determines how the resources array is interpreted.
criteriaJSON object
Represents the details of the blueprint entry criteria. Entry criteria determine which records are eligible to enter the blueprint process.
- comparatorstring
  Represents the comparator used in the criteria expression.
  Possible values: is, isn't, contains, doesn't contain, starts with, ends with, is empty, is not empty.
- fieldJSON object
  Represents the field details configured in the criteria. This field is evaluated to decide whether the record satisfies the blueprint entry condition.
  - api_namestring
    Represents the API name of the field used in the criteria.
  - idstring
    Represents the ID of the field used in the criteria.
- typestring
  Represents what the criteria is based on, such as comparison against a fixed value or another field.
- valuestring
  Represents the value configured for the criteria comparison when the condition is value-based.
chart_dataJSON object
Contains the details of the visual chart representation of the configured blueprint. This section stores the canvas layout used in the Blueprint editor, including node positions, visual connectors, and canvas dimensions.
Keep chart_data consistent with the logical structure defined in states, transitions, and connections.
Important: Although optional in schema, chart_data is practically required before first activation so that the blueprint renders correctly in the editor.
- nodesJSON array
  Contains details of the nodes of the blueprint. Nodes represent the states of the blueprint as displayed in the visual editor.
  - position_xinteger
    Position of the node on the x-axis within the blueprint canvas.
  - position_yinteger
    Position of the node on the y-axis within the blueprint canvas.
  - stateJSON object
    Contains details of the state mapped to the node. In Zoho CRM, a state represents a stage or condition in the business process.
    - api_namestring
      Represents the API name of the state represented by the node.
- canvas_sizeJSON object
  Use canvas_size to configure the height and width of the canvas on which the blueprint chart data is displayed in the Blueprint editor.
  - widthinteger
    Width of the blueprint chart canvas.
  - heightinteger
    Height of the blueprint chart canvas.
- connectionsJSON array
  Details of the visual connections between nodes in the blueprint chart. These connections represent the graphical flow between states and are associated with transitions.
  - fromJSON object
    Details of the source side of the visual connection.
    - end_pointJSON object
      Details of the end point of the source side of the connection in the blueprint canvas.
      - position_xdouble
        Position of the source point on the x-axis.
      - position_yinteger
        Position of the source point on the y-axis.
      - direction_xinteger
        Horizontal direction of the connection line from the source point.
      - direction_yinteger
        Vertical direction of the connection line from the source point.
    - stateJSON object
      Contains state details of the source node from which the connection begins.
      - api_namestring
        Represents the API name of the source state.
  - api_namestring
    Represents the API name of the visual connection.
  - toJSON object
    Details of the target side of the visual connection.
    - end_pointJSON object
      End point details of the target side of the connection.
      - position_xinteger
        Position of the target point on the x-axis.
      - position_ydouble
        Position of the target point on the y-axis.
      - direction_xinteger
        Horizontal direction of the connection line toward the target point.
      - direction_yinteger
        Vertical direction of the connection line toward the target point.
    - stateJSON object
      Contains state details of the target node to which the connection points.
      - api_namestring
        Represents the API name of the target state.
  - transitionJSON object
    Details of the transition mapped with the connection. In Zoho CRM, a transition is the action that moves a record from one state to another.
    - api_namestring
      Represents the API name of the transition associated with the connection.
    - namestring
      Name of the transition shown in the process design.
continuous Boolean
Specifies whether the blueprint runs in continuous mode.
Set to true for continuous execution behavior where records can continue through configured process paths. Set to false for one-time progression behavior through the configured path.
moduleJSON object
Contains the details of the module for which the blueprint is configured. A blueprint in Zoho CRM always applies to a specific module and governs the records in that module.
- api_namestring
  Represents the API name of the module.
- idstring
  Represents the ID of the module.
- precedenceinteger
  Represents the precedence of the module where applicable in the configuration.
pipelineJSON object
Contains the details of the pipeline for which the blueprint is configured. This is applicable only for the Deals module and is used when the blueprint should apply only to records in a specific sales pipeline.
- idstring
  Represents the ID of the pipeline.
- api_namestring
  Represents the API name of the pipeline.
- display_valuestring
  Represents the display value of the pipeline as shown in the CRM UI.
transitionsJSON array
Represents the transitions associated with the blueprint. A transition is the action or step that moves a record from one state to another. Transitions can be manual or automatic, may require inputs during execution, and can trigger automation after completion.
- criteriaJSON object
  Represents the criteria configured for displaying or allowing the transition. This determines whether the transition is available based on record data.
  - comparatorstring
    Represents the comparator of the criteria.
  - fieldJSON object
    Represents field details configured in the criteria.
    - api_namestring
      Represents the API name of the field.
    - idstring
      Represents the ID of the field.
  - typestring
    Represents whether the criteria compares against a value or another field.
  - valuestring
    Represents the value used in the criteria comparison.
- trigger_typestring
  Represents whether the transition is triggered manually or automatically.
  Possible values: manual, automatic.
  Automatic transitions move the record after a configured wait time in the current state.
- moduleJSON object
  Represents module details for which the transition is configured.
  - api_namestring
    Represents the API name of the module.
  - idstring
    Represents the ID of the module.
- layoutJSON object
  Represents the details of the layout context for the transition.
  - api_namestring
    Represents the API name of the layout.
  - namestring
    Represents the name of the layout.
  - idstring
    Represents the ID of the layout.
- descriptionstring
  Description of the transition and its business purpose within the process flow.
- ownersJSON array
  Represents the details of the owners for whom the transition is accessible. This controls who can execute the transition.
  - resourcesJSON array
    Represents the details of the transition owners.
    - idstring
      Represents the ID of the transition owner.
  - typestring
    Represents the type of the owner.
    Possible values: users, role, group, record_owner, portal_user_type.
- commonBoolean
  Represents whether the transition is a common transition. A common transition can be made available from multiple source states.
- include_statesJSON array
  Represents the details of the common source states for the transition when the transition is configured as common.
  - stateJSON object
    Represents the state details of the common source.
    - namestring
      Represents the name of the state.
    - api_namestring
      Represents the API name of the state.
- during_inputsJSON array
  List of the fields configured during the transition. This defines what a user must do at the exact moment they click a transition button to advance a record. It acts as a mandatory validation checkpoint that enforces data collection and process compliance before the record updates to the next stage.
  - validation_filterJSON object
    Details of validation configured for the during-transition fields. If validation fails, the transition cannot be completed.
    - criteriaJSON object
      Criteria to validate the field.
      - comparatorstring
        Comparator of the criteria.
      - fieldJSON object
        Field details of the criteria.
        api_namestring
        Represents the API name of the field.
        idstring
        Represents the ID of the field.
      - typestring
        Type of the criteria to denote whether it is checked against a field value or another field.
      - valuestring
        Value against which the field value should be checked.
    - validation_messagestring
      Message to be displayed when validation fails.
  - sequenceinteger
    Position in which the field should be displayed in the transition popup.
  - fieldJSON object
    Details of the field configured in during transition.
    - api_namestring
      Represents the API name of the field.
    - idstring
      Represents the ID of the field.
  - optionalBoolean
    Denotes whether the input is optional for the user during the transition.
  - typestring
    Type of the configured input.
    Possible values: field, related_list, info, attachment, tags, notes, checklist, widget, kiosk.
- api_namestring
  Represents the API name of the transition.
- namestring
  Represents the name of the transition.
- transition_typestring
  Represents the type of transition relationship.
  Possible values: standalone_transition, parallel_transition, child_transition.
- actionsJSON array
  List of actions configured to be triggered after the transition is completed. These actions correspond to the automation that runs in the After Transition stage.
  - namestring
    Represents the name of the action associated with the transition.
  - detailsJSON object
    Represents the details of the configured action.
    - namestring
      Represents the name of the action.
    - idstring
      Represents the ID of the action. Retrieve this value using the corresponding action-specific Get API based on the selected action type.
  - idstring
    Represents the ID of the action associated with the transition.
  - typestring
    Represents the type of the action.
    Possible values: field_updates, add_tags, remove_tags, email_notifications, sms, whatsapp, tasks, create_record, add_meeting, schedule_call, convert, webhooks, functions.
- color_codestring
  Represents a visual color code associated with the transition for display or editor representation.
statesJSON array
Represents the list of states associated with the blueprint. A state represents a stage or condition in the business process through which a record moves.
- namestring
  Represents the display name of the state.
- api_namestring
  Represents the API name of the state.
- pick_list_valueJSON object
  Represents the picklist option mapped with the state. In Zoho CRM, blueprint states are generally tied to the values of the selected process field.
  - idstring
    Represents the ID of the picklist option.
  - actual_valuestring
    Represents the actual value of the mapped picklist option.
- moduleJSON object
  Represents the module details for which the state is configured.
  - api_namestring
    Represents the API name of the module.
  - idstring
    Represents the ID of the module.
- state_escalationJSON object
  Represents escalation alert configuration for the state. State escalation can trigger actions if a record remains in the state longer than the configured duration.
  - periodstring
    Represents the time period type.
    Possible values: days, hours, minutes, business_days, business_hours.
  - valueinteger
    Represents the numeric value of the defined period.
  - trigger_detailsJSON array
    Represents trigger configurations for the state escalation.
    - periodstring
      Represents the period type for the trigger.
      Possible values: days, hours, minutes.
    - execute_typestring
      Represents when the trigger executes relative to the escalation point.
      Possible values: before, on, after.
    - valueinteger
      Represents the time value for trigger execution.
    - actionsJSON array
      Represents the list of actions configured for the trigger.
      - detailsJSON object
        escalate_toJSON array
        idstring
        typestring
        Possible values: user, role, group, team_user, profile.
        idstring
        Represents the ID of the configured escalation action. Retrieve this value using the corresponding action-specific Get API based on the selected action type.
        namestring
      - idstring
      - namestring
      - typestring
        Possible values: sla, email_notifications, tasks, field_updates, webhooks, functions, circuits, whatsapp, sms.
layoutJSON object
Represents the details of the layout for which the blueprint is configured. Layout mapping ensures that the process applies within the intended record design and business context.
- api_namestring
  Represents the API name of the layout.
- namestring
  Represents the name of the layout.
- idstring
  Represents the ID of the layout.
fieldJSON object
Represents the details of the field for which the blueprint is configured. This is the process field whose values are mapped to the states of the blueprint, such as Stage or Status.
- api_namestring
  Represents the API name of the field for which the blueprint is configured.
- field_labelstring
  Represents the label of the field for which the blueprint is configured.
- idstring
  Represents the ID of the field for which the blueprint is configured.
api_namestring
Represents the API name of the blueprint.
namestring
Represents the name of the blueprint. This is the human-readable label used to identify the process configuration in Zoho CRM.
descriptionstring
Represents the description of the blueprint, including its business purpose, scope, or any important notes about how the process should be used.
connectionsJSON array
Represents the logical connections between states mapped with transitions. These connections define how a transition moves a record from one source state to a target state.
Each connection should reference a transition defined in the transitions array.
- to_stateJSON object
  Represents the target state associated with the connection.
  - namestring
    Represents the name of the target state.
  - api_namestring
    Represents the API name of the target state.
- api_namestring
  Represents the API name of the connection.
- transitionsJSON object
  Represents the transition associated with the connection.
  - api_namestring
    Represents the API name of the transition.
  - namestring
    Represents the name of the transition.
  - precedenceinteger
    Represents the precedence of the transition where multiple transitions are associated with similar paths.
- from_stateJSON object
  Represents the source state associated with the connection.
  - namestring
    Represents the name of the source state.
  - api_namestring
    Represents the API name of the source state.

Sample Response

Copied{
    "blueprints": [
        {
            "owner": null,
            "created_time": "2026-05-14T23:43:54-07:00",
            "chart_data": {
                "nodes": [
                    {
                        "position_x": 180,
                        "position_y": -80,
                        "state": {
                            "id": "5843104000008502305"
                        }
                    },
                    {
                        "position_x": 70,
                        "position_y": 20,
                        "state": {
                            "id": "5843104000008502304"
                        }
                    }
                ],
                "canvas_size": {
                    "width": 1013,
                    "height": 707
                },
                "connections": [
                    {
                        "from": {
                            "end_point": {
                                "position_x": "0.4",
                                "position_y": "1",
                                "direction_x": "0",
                                "direction_y": "1"
                            },
                            "state": {
                                "id": "5843104000000006803"
                            }
                        },
                        "id": "5843104000008502303",
                        "to": {
                            "end_point": {
                                "position_x": "0.7",
                                "position_y": "0",
                                "direction_x": "0",
                                "direction_y": "-1"
                            },
                            "state": {
                                "id": "5843104000000006805"
                            }
                        },
                        "transition": {
                            "api_name": "move_to_value_proposition",
                            "name": "move to value proposition",
                            "id": "5843104000008502301"
                        }
                    }
                ]
            },
            "module": {
                "api_name": "Potentials",
                "_precedence": 2,
                "id": "5843104000000002181"
            },
            "description": "",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5843104000000424672"
            },
            "layout": {
                "api_name": "standard3",
                "name": "standard3",
                "id": "5843104000008502160"
            },
            "modified_time": "2026-05-14T23:44:03-07:00",
            "field": {
                "api_name": "Stage",
                "field_label": "Stage",
                "id": "5843104000000002565"
            },
            "api_name": "deal_blueprint_Cloned1",
            "continuous": false,
            "name": "deal blueprint_Cloned1",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5843104000000424672"
            },
            "id": "5843104000008502299",
            "connections": [
                {
                    "from_state": {
                        "name": "Needs Analysis",
                        "id": "5843104000008502305"
                    },
                    "id": "5843104000008502303",
                    "transitions": {
                        "api_name": "move_to_value_proposition",
                        "name": "move to value proposition",
                        "id": "5843104000008502301",
                        "precedence": 1
                    },
                    "to_state": {
                        "name": "Value Proposition",
                        "id": "5843104000008502304"
                    }
                }
            ]
        }
    ]
}

Possible Errors

OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized access due to invalid scope.
Resolution: Generate a new access token with appropriate scope.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed.
Resolution: Pass a valid OAuth access token in the Authorization header.
INVALID_URL_PATTERNHTTP 404
The request URL specified is incorrect.
Resolution: Verify the API endpoint URL.
INTERNAL_ERRORHTTP 500
Unexpected server error.
Resolution: Contact Zoho support.