---
title: "Find a colleague"
method: GET
path: "/v1/colleagues/find"
tags: ["Colleagues"]
---

# Find a colleague

`GET /v1/colleagues/find`

## Request

- Base URL: `https://api.altoviz.com`
- URL: `https://api.altoviz.com/v1/colleagues/find`
- Auth: none required
- TypeScript: <https://skmtc.dev/altoviz/apis/altoviz-api/docs/v1/colleagues/find/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `email` string
- `internalId` string
- `number` string

## Response `200`

OK

- Colleague[]
  - `cellPhone` string, nullable: Cell phone number
  - `email` string, nullable: Email
  - `firstName` string, nullable: First name
  - `homecareServiceNumber` string, nullable: Homecare service number associated with the colleague
  - `id` integer: Colleague Id
  - `initialPartnerBalance` number, double: Initial balance for the partner
  - `internalId` string, nullable: Internal identifier for the colleague
  - `isPartner` boolean: Indicates if the colleague is a partner
  - `lastName` string, nullable: Last name
  - `metadatas` object, 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.
  - `name` string, nullable: Colleague Name
  - `number` string, nullable: Colleague Number
  - `phone` string, nullable: Phone number
  - `title` string, nullable: Title
  - `userId` string, nullable: User identifier associated with the colleague

---

[API](https://skmtc.dev/altoviz/apis/altoviz-api.md) - [All operations](https://skmtc.dev/altoviz/apis/altoviz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/altoviz/apis/altoviz-api/revisions/4f7fa64cf9e3?raw)