Skip to content
SignalSitterDocs

Get organization

GET/v1/organization

See which organization and credential a request is acting as.

Authentication
SignalSitter API credential or Clerk session JWT · REST guide
Operation ID
getOrganizationContext

Parameters

Section titled “Parameters”

Headers

X-Correlation-IDCorrelationId

Optional caller correlation identifier propagated to the response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$

Request body

Section titled “Request body”

No request body.

Responses

Section titled “Responses”
200Successful response
application/jsonOrganizationContext
  • Organization and principal identifiers originate from verified server-side authentication context.
organizationobjectRequired
1 property
idstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
principalone ofRequired
kind: "human"
kindstringRequired
Value
  • "human"
rolestringRequired
One of
  • "owner"
  • "admin"
  • "member"
userIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
kind: "api_credential"
credentialIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9_-]*$
kindstringRequired
Value
  • "api_credential"
presetstringRequired
One of
  • "read"
  • "write"
  • "readwrite"
  • "manage"
scopesarray of stringRequired
  • Minimum items 1
  • Maximum items 14

Each item

One of
  • "callbacks:read"
  • "callbacks:write"
  • "credentials:write"
  • "incidents:read"
  • "incidents:write"
  • "monitors:read"
  • "monitors:write"
  • "observations:read"
  • "organization:write"
  • "organization:destroy"
  • "projects:read"
  • "projects:write"
  • "projects:administer"
  • "usage:read"
2 response headers
X-Correlation-IDCorrelationIdRequired

Correlation identifier shared by related operations.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
X-Request-IDRequestIdRequired

Request identifier for this response.

  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
Errors
  • 400Invalid request
  • 401Authentication required
  • 403Permission denied
  • 404Resource not found
  • 429Authentication rate limited
  • 500Internal server error
  • 503Service temporarily unavailable
Error bodyProblemDetails
application/problem+jsonProblemDetails
  • URI references must pass full URI-reference parsing, including percent escapes, authority brackets, and scheme syntax.
  • Documentation links must parse as credential-free HTTPS URLs or root-relative paths.
  • retryAfterSeconds is allowed only when retryable is true.
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^signalsitter\.[a-z][a-z0-9]*(?:[._][a-z0-9]+)*$
correlationIdstringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[A-Za-z0-9][A-Za-z0-9._:/-]*$
detailstringRequired
  • Minimum length 1
  • Maximum length 1024
  • Pattern ^[^\u0000-\u001F\u007F]*$
fieldErrorsarray of object
  • Maximum items 32

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
pathstringRequired
  • Maximum length 256

All of

Part 1
  • Pattern ^[^\u0000-\u001F\u007F]*$
Part 2
  • Pattern ^(?:|(?:\/(?:[^~]|~[01])*)+)$
instancestring
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
limitobject
7 properties
attemptedinteger
  • Minimum 0
  • Maximum 9007199254740991
currentinteger
  • Minimum 0
  • Maximum 9007199254740991
dimensionstringRequired
One of
  • "active_monitors"
  • "beat_cadence"
  • "minimum_interval_seconds"
  • "measurements_per_observation"
  • "stored_observations"
  • "observation_retention_seconds"
  • "callback_endpoints"
  • "detector_feature"
  • "api_requests_per_minute"
  • "mcp_requests_per_minute"
  • "service_state"
  • "entitlement_lease"
limitinteger
  • Minimum 0
  • Maximum 9007199254740991
planobject
3 properties
idstringRequired
One of
  • "free"
  • "builder"
  • "smart"
  • "scale"
namestringRequired
  • Minimum length 1
  • Maximum length 64
  • Pattern ^[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$
versionintegerRequired
  • Greater than 0
  • Maximum 9007199254740991
remediationstringRequired
One of
  • "upgrade_plan"
  • "reduce_usage"
  • "increase_interval"
  • "remove_feature"
  • "retry_after_refresh"
  • "contact_support"
  • "export_data"
serviceStatestring
One of
  • "active"
  • "payment_grace"
  • "abuse_suspended"
  • "canceled"
  • "deleting"
remediationarray of object
  • Maximum items 8

Each item

3 properties
codestringRequired
  • Minimum length 1
  • Maximum length 128
  • Pattern ^[a-z][a-z0-9_]*$
documentationstring
  • Minimum length 1
  • Maximum length 512

All of

Part 1
  • Pattern ^[^\s\u0000-\u001F\u007F]+$
Part 2
  • Pattern ^(?:\/(?!\/)|[Hh][Tt][Tt][Pp][Ss]:\/\/)
messagestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\u0000-\u001F\u007F]*$
retryablebooleanRequired
retryAfterSecondsinteger
  • Greater than 0
  • Maximum 86400
statusintegerRequired
  • Minimum 400
  • Maximum 599
titlestringRequired
  • Minimum length 1
  • Maximum length 160
  • Pattern ^[^\u0000-\u001F\u007F]*$
typestringRequired
  • Minimum length 1
  • Maximum length 512
  • Pattern ^[^\s\u0000-\u001F\u007F]+$

Operation contract

Section titled “Operation contract”

The operation exactly as it appears in the generated contract. References resolve within the OpenAPI document.

Show raw OpenAPI for getOrganizationContext
{
  "operationId": "getOrganizationContext",
  "parameters": [
    {
      "description": "Optional caller correlation identifier propagated to the response.",
      "in": "header",
      "name": "X-Correlation-ID",
      "required": false,
      "schema": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OrganizationContext"
          }
        }
      },
      "description": "Successful response",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "400": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Invalid request",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "401": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication required",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "403": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Permission denied",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "404": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Resource not found",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "429": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Authentication rate limited",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "500": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Internal server error",
      "headers": {
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    },
    "503": {
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ProblemDetails"
          }
        }
      },
      "description": "Service temporarily unavailable",
      "headers": {
        "Retry-After": {
          "description": "Required retry delay in seconds.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RetryAfterHeader"
          }
        },
        "X-Correlation-ID": {
          "description": "Correlation identifier shared by related operations.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/CorrelationId"
          }
        },
        "X-Request-ID": {
          "description": "Request identifier for this response.",
          "required": true,
          "schema": {
            "$ref": "#/components/schemas/RequestId"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiCredential": []
    },
    {
      "clerkSession": []
    }
  ],
  "summary": "Read the verified organization and principal context",
  "tags": [
    "Organization"
  ]
}
SignalSitter documentation