---
title: "Get workspace contact list."
method: GET
path: "/api/v1/contact/workspace"
tags: ["Contact"]
---

# Get workspace contact list.

`GET /api/v1/contact/workspace`

## Request

- Base URL: `https://api.intheloop.io`
- URL: `https://api.intheloop.io/api/v1/contact/workspace`
- Auth: API key in header `Authorization`

## Query parameters

- `size` integer
- `searchQuery` string
- `explicitContactId` string
- `excludeContactIds` string[]
- `workspaceId` string
- `includeMemberTypes` SubscriptionMemberType[]

## Headers

- `Loop-Workspace-Id` string
- `Authorization` string
- `X-Impersonate-User` string

## Response `200`

OK

- ListOfResourcesOfContactBase: List of resources
  - `resources` ContactBase[]: List of resources
    - `id` string: Resource id
    - `name` string: Resource name or title
    - `revision` string: Resource revision
    - `clientId` string: Resource client id
    - `$type` string, required
    - `tags` ListOfTags: List of tags resource
      - `id` string: Resource id
      - `name` string: Resource name or title
      - `revision` string: Resource revision
      - `clientId` string: Resource client id
      - `$type` string, required
      - `tags` ListOfResourcesOfTag: List of resources
        - `resources` Tag[]: List of resources
          - `id` string: Resource id
          - `name` string: Resource name or title
          - `revision` string: Resource revision
          - `clientId` string: Resource client id
          - `$type` string, required
          - `tagType` string: Tag type. If TagType is the same as Id, that means that this is a system board and can not be altered by clients
        - `size` integer, required: Page size
        - `offset` integer, required: Page offset
        - `offsetHistoryId` string: Offset history id
        - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size
      - `parent` ResourceBase: Resource base
        - `id` string: Resource id
        - `name` string: Resource name or title
        - `revision` string: Resource revision
        - `clientId` string: Resource client id
        - `$type` string, required
    - `weight` number: Usage weight.
    - `created` string, date-time: Date time of contact creation
    - `modified` string, date-time: Date time of last time contact was modified
  - `size` integer, required: Page size
  - `offset` integer, required: Page offset
  - `offsetHistoryId` string: Offset history id
  - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

## Other responses

- `400`: Bad request. Check fields message and error code from response body for additional information.
- `401`: Unauthorized request. Check fields message and error code from response body for additional information.
- `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request.
- `451`: Unavailable because account is not verified.

---

[API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)