Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

Scope

List scopes

Changed on Oct 15, 2026

List scopes within an application.

get/scope

Request

Base URL
https://api.nullplatform.com
URL
https://api.nullplatform.com/scope
Auth
HTTP bearer

Query parameters

offsetinteger

The starting point for pagination. Defaults to 0 if not provided.

limitinteger

The maximum number of results to return per page. Defaults to 30 when filtering by application_id. When filtering by nrn, it defaults to 10 and can't exceed 100.

application_idstring required

The ID of the application for the scopes being listed. Allows up to 10 comma-separated values."

include_messagesboolean

Specifies whether it includes messages in the response.

Status of the scope.

type'custom' | 'web_pool' | 'web_pool_k8s' | 'serverless'

Type of the scope.

nrnstring

Filters scopes matching or more specific than the provided NRN. When provided, scopes are listed across the org/account/namespace/application hierarchy instead of by application_id.

providerstring

Filters scopes by provider. Use the same value as the scope's provider field.

namestring

Filters scopes by name.

slugstring

Filters scopes by slug.

dimensionsstring

Filters scopes by dimensions.

sortstring

Sort field and direction, separated by a colon. Defaults to created_at:desc.

Response

The list of scopes matching the query.

Example response

{
  "paging": {
    "total": 30,
    "limit": 30
  },
  "results": [
    {
      "nrn": "organization=1:account=2:namespace=3:application=4:scope=5",
      "id": 1234,
      "name": "Billing API",
      "asset_name": "main-asset",
      "type": "custom",
      "provider": "9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8",
      "status": "active",
      "slug": "billing-api",
      "domain": "billing-api-prod.nullapps.io",
      "application_id": 2345,
      "requested_spec": {
        "memory_in_gb": 2,
        "cpu_profile": "standard",
        "local_storage_in_gb": 8
      },
      "tier": "important",
      "tags": [
        "requires_deployment",
        "high_priority"
      ],
      "profiles": [
        "environment_production"
      ],
      "dimensions": {
        "environment": "production"
      },
      "runtime_configurations": [
        1234,
        2345
      ],
      "domains": [
        {
          "id": "e78a0d21-3c48-7421-81cd-203fe84b8e47",
          "name": "api.crypto-inc.com",
          "type": "scope",
          "nrn": "organization=1:account=2:namespace=3:application=4:scope=1234",
          "selector": {
            "organization_id": 1,
            "nrn": "organization=1:account=2:namespace=3:application=4:scope=1234",
            "scope_id": 1234
          },
          "status": "active",
          "created_at": "2025-01-02T00:00:00Z",
          "updated_at": "2025-02-02T00:00:00Z"
        }
      ],
      "instance_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "application_name": "Billing Service",
      "stops_at": "2026-04-01T00:00:00Z",
      "created_at": "2025-01-02T00:00:00Z",
      "updated_at": "2025-06-15T12:30:00Z",
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

Oct 15, 2026728d4df70ca1 Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the ///// response's property type changed from string to integer for status
- breaking
  the ///// response's property type changed from string to integer for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added the new optional query request parameter provider
- info
  added the new enum value recreating to the query request parameter status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response's property default value 2 was removed for the status
- info
  the response's property default value 2 was removed for the status
- info
  response property message deprecated
- info
  response property message deprecated
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Sep 22, 2026730fb95f21b8 Revision changes
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response optional property // became read-only for the status
- info
  the response required property // became read-only for the status
- info
  the response required property // became read-only for the status

Operation history