---
title: "List teammates"
method: GET
path: "/v1/teammates"
tags: ["Teammates"]
---

# List teammates

`GET /v1/teammates`

## Request

- Base URL: `https://api.scribe-mail.com`
- URL: `https://api.scribe-mail.com/v1/teammates`
- Auth: HTTP bearer

## Query parameters

- `search` string
- `integration_entity_id` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Workspace scoping

- ApiV1TeammateCollectionResponse
  - `data` object[], required
    - `id` string, required
    - `type` 'teammate', required
    - `attributes` object, required
      - `first_name` string, nullable, required
      - `last_name` string, nullable, required
      - `emails` object[], required
        - `address` string, required
        - `primary` boolean, required
      - `role` string, nullable, required
      - `integration_entities` object[], required
        - `id` string, required
        - `name` string, required
        - `kind` string, required
      - `signature_status` object, required
        - `assigned_templates` integer, required
        - `installed` integer, required
        - `pending` integer, required
        - `failed` integer, required
      - `smart_fields` object, required
      - `created_at` string, required
  - `meta` ApiV1Meta, required
    - `request_id` string, required

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/scribe-mail/apis/scribe-public-api.md) · [All operations](https://skmtc.dev/scribe-mail/apis/scribe-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scribe-mail/apis/scribe-public-api/revisions/2ab8476d37d5?raw)