Skip to content

Client Self-Service ​

Manage your client organization information.

Authentication ​

Requires a Client token.

Endpoints ​

Get Client Info ​

Retrieve information about the authenticated client.

http
GET /ext/latest/client
Authorization: Bearer {token}

Response:

json
{
  "data": {
    "clientId": "a587f055-12ff-4009-a4b2-6300f665f35e",
    "name": "Acme Medical Group",
    "contactName": "Jane Doe",
    "contactEmail": "jdoe@acmemedical.com",
    "contactPhone": "555-123-4567",
    "groupNpi": "1234567890",
    "phone": "555-100-2000",
    "faxNumber": "555-100-2001",
    "externalId": "acme_001",
    "siteUrl": "https://acmemedical.com",
    "address": {
      "addressLine1": "100 Health Ave",
      "addressLine2": "Suite 200",
      "city": "Springfield",
      "state": "MA",
      "zip": "01103"
    },
    "emailAddresses": ["info@acmemedical.com"]
  }
}

Update Client Info ​

Update your client organization information.

http
PUT /ext/latest/client
Content-Type: application/json
Authorization: Bearer {token}

Request Body: (all fields optional)

json
{
  "contactName": "Jane Smith",
  "contactEmail": "jsmith@acmemedical.com",
  "contactPhone": "555-123-4568",
  "phone": "555-100-2000",
  "faxNumber": "555-100-2001",
  "siteUrl": "https://acmemedical.com",
  "address": {
    "addressLine1": "100 Health Ave",
    "addressLine2": "Suite 200",
    "city": "Springfield",
    "state": "MA",
    "zip": "01103"
  }
}

Response:

json
{
  "data": { ... }
}

Examples ​

Node.js ​

javascript
import fetch from 'node-fetch';

async function getClientInfo(token) {
  const response = await fetch('https://api.vivliohealth.io/ext/latest/client', {
    headers: { Authorization: `Bearer ${token}` }
  });
  return response.json();
}

async function updateClientInfo(token, updates) {
  const response = await fetch('https://api.vivliohealth.io/ext/latest/client', {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: `Bearer ${token}`
    },
    body: JSON.stringify(updates)
  });
  return response.json();
}

Python ​

python
import requests

def get_client_info(token):
    response = requests.get(
        'https://api.vivliohealth.io/ext/latest/client',
        headers={'Authorization': f'Bearer {token}'}
    )
    response.raise_for_status()
    return response.json()

def update_client_info(token, updates):
    response = requests.put(
        'https://api.vivliohealth.io/ext/latest/client',
        headers={
            'Content-Type': 'application/json',
            'Authorization': f'Bearer {token}'
        },
        json=updates
    )
    response.raise_for_status()
    return response.json()

Response Fields ​

FieldTypeDescription
clientIdstringSystem-generated UUID (read-only)
namestringOrganization name
contactNamestringPrimary contact name
contactEmailstringPrimary contact email
contactPhonestringPrimary contact phone
contactExternalIdstringExternal identifier for the contact person (nullable)
groupNpistringGroup NPI (10 digits)
phonestringOrganization phone
faxNumberstringOrganization fax
externalIdstringExternal system identifier
siteUrlstringWebsite URL
addressobjectOrganization address
emailAddressesarrayList of email addresses
clientOidstringSystem-generated OID (read-only)
taxEinstringTax EIN (nullable)
partnerIdstringOwning partner ID (read-only)
webhookUrlstringURL for event notifications — updatable by partner only
webhookEnabledbooleanEnable/disable webhook delivery

See Webhooks for configuration steps, event types, and payload/signature details.

Error Responses ​

StatusCodeDescription
400VALIDATION_ERRORInvalid fields
401FORBIDDENMissing or invalid authentication
404RESOURCE_NOT_FOUNDClient not found
500INTERNAL_ERRORServer error

Vivlio Health API Documentation