DE Start monitoring
API reference · Organization

Clients (agency mode)

The agency partition: clients, client teams, share links, archive/unarchive.

Base URL https://app.upfour.io/v1 · auth via Authorization: Bearer <key> · “Try it” runs from your browser — the key is kept in this tab only. Use a pls_test_ sandbox key to experiment freely.

GET /clients

scope client.write stable returns 200

ParameterInTypeNotes
limit query integer default 50
cursor query string
client_id query uuid
all_clients query boolean
q query string
sort query string 
curl -s https://app.upfour.io/v1/clients \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

POST /clients

scope client.write stable returns 201 

curl -s -X POST https://app.upfour.io/v1/clients \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

GET /clients/{clientID}

scope client.write stable returns 200

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s https://app.upfour.io/v1/clients/<clientID> \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

PUT /clients/{clientID}

scope client.write stable returns 200

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s -X PUT https://app.upfour.io/v1/clients/<clientID> \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

POST /clients/{clientID}/archive

scope client.write stable returns 201

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s -X POST https://app.upfour.io/v1/clients/<clientID>/archive \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

GET /clients/{clientID}/portal-settings

scope client.write stable returns 200

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s https://app.upfour.io/v1/clients/<clientID>/portal-settings \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

PUT /clients/{clientID}/portal-settings

scope client.write stable returns 200

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s -X PUT https://app.upfour.io/v1/clients/<clientID>/portal-settings \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

POST /clients/{clientID}/share-links

scope client.write stable returns 201

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s -X POST https://app.upfour.io/v1/clients/<clientID>/share-links \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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

GET /clients/{clientID}/teams

scope client.read stable returns 200

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s https://app.upfour.io/v1/clients/<clientID>/teams \
  -H "Authorization: Bearer $UP4_API_KEY"
Try it

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

POST /clients/{clientID}/unarchive

scope client.write stable returns 201

ParameterInTypeNotes
clientIDrequired path uuid 
curl -s -X POST https://app.upfour.io/v1/clients/<clientID>/unarchive \
  -H "Authorization: Bearer $UP4_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Try it

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