Skip to main content
List applications for a project
curl --request GET \
  --url https://sapi.withsutro.com/projects/{projectId}/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'x-sutro-api-client: <api-key>'
import requests

url = "https://sapi.withsutro.com/projects/{projectId}/applications"

headers = {
"Authorization": "Bearer <token>",
"x-sutro-api-client": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'x-sutro-api-client': '<api-key>'}
};

fetch('https://sapi.withsutro.com/projects/{projectId}/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sapi.withsutro.com/projects/{projectId}/applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-sutro-api-client: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sapi.withsutro.com/projects/{projectId}/applications"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("x-sutro-api-client", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sapi.withsutro.com/projects/{projectId}/applications")
.header("Authorization", "Bearer <token>")
.header("x-sutro-api-client", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sapi.withsutro.com/projects/{projectId}/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-sutro-api-client"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scode": {
      "requirements": [
        {
          "id": "<string>",
          "description": "<string>",
          "parentId": "<string>"
        }
      ],
      "appId": "<string>",
      "version": "<string>",
      "appOverview": {
        "name": "<string>",
        "jobToBeDone": "<string>",
        "unsupportedUserJourneys": [
          {
            "name": "<string>",
            "description": "<string>",
            "reason": "<string>",
            "steps": [
              "<string>"
            ]
          }
        ],
        "draftUserJourneys": [
          {
            "name": "<string>",
            "outcome": "<string>",
            "steps": [
              "<string>"
            ]
          }
        ]
      },
      "appDescription": "<string>",
      "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>"
          }
        ]
      },
      "domainModel": {
        "models": [
          {
            "name": "<string>",
            "fields": [
              {
                "name": "<string>",
                "type": "<string>"
              }
            ],
            "requirements": [
              {
                "id": "<string>",
                "description": "<string>",
                "parentId": "<string>"
              }
            ],
            "isUserModel": true
          }
        ]
      },
      "actions": [
        {
          "id": "<string>",
          "effects": [
            {
              "actionEffectId": "<string>",
              "effect": "<string>",
              "params": {},
              "bindParams": {},
              "next": "<string>",
              "onError": {
                "nextId": "<string>",
                "continueOriginalFlow": true
              }
            }
          ],
          "startEffectId": "<string>",
          "bindReturnValue": "<string>",
          "onError": {
            "nextId": "<string>",
            "continueOriginalFlow": true
          },
          "referenceRequirements": [
            "<string>"
          ]
        }
      ],
      "triggers": [
        {
          "trigger": {
            "id": "<string>",
            "type": "<unknown>",
            "eventName": "<string>",
            "payload": {}
          },
          "actionId": "<string>",
          "initialState": {},
          "validation": [
            "<string>"
          ],
          "isPublic": true,
          "referenceRequirements": [
            "<string>"
          ]
        }
      ],
      "userModelId": "<string>",
      "models": [
        {
          "id": "<string>",
          "name": "<string>",
          "fields": [
            {
              "id": "<string>",
              "name": "<string>",
              "relationshipOwner": true,
              "min": 123,
              "max": 123,
              "to": "<string>",
              "accessControl": {
                "rules": [
                  {
                    "criteria": "<string>"
                  }
                ]
              },
              "computed": "<string>",
              "defaultValue": "<unknown>",
              "enum": [
                "<string>"
              ]
            }
          ],
          "accessControl": {
            "rules": [
              {
                "criteria": "<string>"
              }
            ]
          },
          "referenceRequirements": [
            "<string>"
          ]
        }
      ],
      "personas": [
        {
          "name": "<string>"
        }
      ]
    },
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "jobs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "implementationJobId": "<string>",
          "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": {},
          "errorMessage": "<string>",
          "errorStack": "<string>",
          "startedAt": "<string>",
          "completedAt": "<string>"
        }
      ]
    },
    "isActive": true,
    "name": "<string>",
    "serverVersion": "<string>",
    "lastPublishedAt": "2023-11-07T05:31:56Z",
    "lastUnpublishedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

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

projectId
string<uuid>
required

Response

A list of applications for the project

id
string<uuid>
required

Unique identifier for the application

scode
SCode representation of an Application · object
required

The application's SCode definition

projectId
string<uuid>
required

The project this application belongs to

status
object
required
isActive
boolean
required

Whether the application is currently active for billing/runtime purposes

name
string

The name of the application

serverVersion
string

The current saved server version (semver)

lastPublishedAt
string<date-time>

When the application was last published

lastUnpublishedAt
string<date-time>

When the application was last unpublished

createdAt
string<date-time>
updatedAt
string<date-time>