Get a client

Returns a Client with its name, slug, language, timezone, logo and portal access setting.

GET https://app.upfour.io/v1/clients/{clientID}

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs client.read.

Path

clientIDpath · requiredPart of the request path.

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 client.read stable returns 200

Parameters

Field	Type	Description
`clientID` required	uuid	path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data Client

Client · 20 fields

Field Type Description

allow_login boolean

contact_email string

created_at string (date-time)

id uuid

language string · nullable one ofende

logo StoredClientLogo

StoredClientLogo · 4 fields

Field	Type	Description
`background`	string one of`lightdarktransparent`	The background the logo is made for.
`dark`	string	Same as standard, for dark backgrounds. Needs a standard logo.
`icon`	string	Same as standard, for compact places. Needs a standard logo.
`standard`	string	Request: a PNG as data:image/png;base64,... of at most 192 KiB, or the value the client already has to keep that image; empty removes it. Response: the path of the stored image.

logo_url string A hosted logo; empty once a standard logo is stored.

name string

organization_id uuid

slug string

timezone string

updated_at string (date-time)

archived_at string (date-time) Set while the client is archived.

effective_language string one ofende Only in the answer for one client: the language the client actually gets, its own or the company default.

monitor_count integer Only in lists, omitted when zero.

open_incidents integer Only in lists, omitted when zero.

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.

const res = await fetch("https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001", { headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.get( "https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "allow_login": false, "contact_email": "anna@example.com", "created_at": "2026-10-27T09:00:00Z", "effective_language": "en", "id": "00000000-0000-4000-8000-000000000001", "language": "en", "logo": { "background": "light", "dark": "", "icon": "", "standard": "" }, "logo_url": "", "name": "Globex Corp", "organization_id": "00000000-0000-4000-8000-000000000002", "slug": "globex", "timezone": "Europe/Berlin", "updated_at": "2026-10-27T09:00:00Z" } }