ALaltoviz
Colleagues

Find a colleague

get/v1/colleagues/find

Request

Query parameters

emailstring

Colleague email

internalIdstring

Colleague internal ID

numberstring

Colleague internal ID

Response

OK

cellPhonestring nullable

Cell phone number

emailstring nullable

Email

firstNamestring nullable

First name

homecareServiceNumberstring nullable

Homecare service number associated with the colleague

idinteger

Colleague Id

initialPartnerBalancenumber double

Initial balance for the partner

internalIdstring nullable

Internal identifier for the colleague

isPartnerboolean

Indicates if the colleague is a partner

lastNamestring nullable

Last name

metadatasobject nullable

Metadata: free-form key/value pairs carried with the colleague, for an integration to keep its own identifiers and flags against it.

Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as null. Omitting the property entirely leaves the whole bag untouched, and "" stores an empty value rather than removing the key.

namestring nullable

Colleague Name

numberstring nullable

Colleague Number

phonestring nullable

Phone number

titlestring nullable

Title

userIdstring nullable

User identifier associated with the colleague

Changes

No recorded changes to this operation across all 3 revisions of this API.