Skip to main content

Get a client by its ID

Get a client by its ID

Path Parameters
key uuid — REQUIRED
Query Parameters
$top String

The max number of records.

$skip String

The number of records to skip.

$filter String

A function that must evaluate to true for a record to be returned.

$select String

Specifies a subset of properties to return. Use a comma separated list.

$orderby String

Determines what values are used to order a collection of records.

$expand String

Use to add related query data.

Header Parameters
x-instance string

The target instance for the request

x-company string

The target company for the request

Responses
200

Success

Schema — OPTIONAL
id uuid — OPTIONAL
name String — OPTIONAL
roles object[] — OPTIONAL
id uuid — OPTIONAL
description String — OPTIONAL
type String — OPTIONAL
resource object — OPTIONAL
id uuid — OPTIONAL
no String — OPTIONAL
name String — OPTIONAL
defaults object[] — OPTIONAL
id uuid — OPTIONAL
validFrom date-time — OPTIONAL
workHourTemplate object — OPTIONAL
id uuid — OPTIONAL
code String — OPTIONAL
description String — OPTIONAL
monday float — OPTIONAL
tuesday float — OPTIONAL
wednesday float — OPTIONAL
thursday float — OPTIONAL
friday float — OPTIONAL
saturday float — OPTIONAL
sunday float — OPTIONAL
calendar object — OPTIONAL
code String — OPTIONAL
description String — OPTIONAL
entries object[] — OPTIONAL
id uuid — OPTIONAL
date date-time — OPTIONAL
description String — OPTIONAL
recurrent Boolean — OPTIONAL
isWorking Boolean — OPTIONAL
validUntil date-time — OPTIONAL