Skip to main content
GET
/
applications
/
{applicationId}
/
spec
Get the Sutro Spec for the Application
curl --request GET \
  --url https://local.withsutro.com/applications/{applicationId}/spec \
  --header 'Authorization: Bearer <token>' \
  --header 'x-sutro-api-client: <api-key>'
{
  "sitemap": {
    "nodes": [
      {
        "id": "<string>",
        "route": "<string>",
        "content": [
          {
            "title": "<string>",
            "description": "<string>"
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "<string>",
        "to": "<string>",
        "type": "<string>"
      }
    ]
  },
  "appOverview": {
    "name": "<string>",
    "jobToBeDone": "<string>",
    "unsupportedUserJourneys": [
      {
        "name": "<string>",
        "description": "<string>",
        "reason": "<string>",
        "steps": [
          "<string>"
        ]
      }
    ],
    "draftUserJourneys": [
      {
        "name": "<string>",
        "outcome": "<string>",
        "steps": [
          "<string>"
        ]
      }
    ]
  },
  "personas": [
    {
      "name": "<string>"
    }
  ],
  "domainModel": {
    "models": [
      {
        "name": "<string>",
        "fields": [
          {
            "name": "<string>",
            "type": "<string>",
            "relationshipType": "hasOne"
          }
        ],
        "requirements": [
          {
            "id": "<string>",
            "description": "<string>",
            "parentId": "<string>"
          }
        ],
        "isUserModel": true
      }
    ]
  },
  "appDraft": {
    "sitemap": {
      "nodes": [
        {
          "id": "<string>",
          "route": "<string>",
          "content": [
            {
              "title": "<string>",
              "description": "<string>"
            }
          ]
        }
      ],
      "edges": [
        {
          "from": "<string>",
          "to": "<string>",
          "type": "<string>"
        }
      ]
    },
    "requirements": [
      {
        "id": "<string>",
        "description": "<string>",
        "parentId": "<string>"
      }
    ]
  },
  "requirements": [
    {
      "id": "<string>",
      "description": "<string>",
      "parentId": "<string>"
    }
  ],
  "views": {}
}

Authorizations

Authorization
string
header
required

Builder authentication and authorization

x-sutro-api-client
string
header
required

A unique identifier for the API Client making a request

Path Parameters

applicationId
string<uuid>
required

Response

The Sutro spec for the Application

sitemap
object
required
appOverview
object
required
personas
object[]
required
domainModel
object
required
appDraft
object
required
requirements
object[]
required
views
object
required