Customization

Get Stage Diagram (POST)

Gets a stage diagram.

POST
/stage-diagrams.get
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

id?string

The ID of the stage diagram to get.

Formatid
is_custom_leaf_type?boolean

Whether the leaf type corresponds to a custom object. Specify this along with leaf_type to get the default custom object stage diagram.

leaf_type?string

The leaf type. Should be specified to retrieve the default stage diagram for the leaf type. If not provided, then id is used.

Formattext

Response Body

curl -X POST "https://api.devrev.ai/stage-diagrams.get" \  -H "Content-Type: application/json" \  -d '{}'
{
  "stage_diagram": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "is_custom_leaf_type": true,
    "is_default": true,
    "leaf_type": "string",
    "name": "string",
    "stages": [
      {
        "is_deprecated": true,
        "is_start": true,
        "stage": {
          "display_id": "string",
          "id": "string",
          "name": "string"
        },
        "transitions": [
          {
            "target_stage": {
              "display_id": "string",
              "id": "string",
              "name": "string"
            }
          }
        ]
      }
    ]
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}