Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Get company details

Returns the Company name, slug, owner ID, settings and creation and update timestamps.

GET https://app.upfour.io/v1/organization
GET https://app.upfour.io/v1/organization
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs organization.read.
Query

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope organization.read stable returns 200

Parameters

FieldTypeDescription
limit optional integer 1–250default 50 query parameter
cursor optional string query parameter
client_id optional uuid query parameter
all_clients optional boolean query parameter
q optional string query parameter
sort optional string query parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data Organization
Organization · 8 fields
FieldTypeDescription
created_at string (date-time)
id uuid
name string
owner_id uuid
settings object · nullable free-form keys Company settings, for example timezone, date_format (day_month_year, month_day_year or iso), default_language (en or de) and incident_screenshots_default. The audit drain secret is never returned.
slug string
updated_at string (date-time)
deleted_at string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.