---
title: "Claim connect code"
method: POST
path: "/api/v1/warehouse-connect/claim"
tags: ["Projects"]
---

# Claim connect code

`POST /api/v1/warehouse-connect/claim`

Retrieves credentials deposited against a connect code created by the
current user. Returns them once and deletes the code

## Request body

- ClaimWarehouseConnectCodeRequest
  - `code` string, required

## Response `200`

Success

- ApiWarehouseConnectCodeClaimResponse
  - `results` union, required
    - object
      - `status` 'pending', required
    - object
      - `inventory` WarehouseConnectInventory, required
        - `schemas` object[], required
          - `name` string, required
          - `database` string, required
        - `roles` object[], required
          - `isDefault` boolean, required
          - `name` string, required
        - `warehouses` object[], required
          - `state` string, nullable, required
          - `size` string, nullable, required
          - `name` string, required
        - `databases` object[], required
          - `sizeBytes` number, double, nullable
          - `comment` string, nullable, required
          - `name` string, required
      - `credentials` DepositSnowflakeCredentials, required — Make all properties in T optional
        - `type` 'snowflake', required
        - `user` string, required
        - `password` string
        - `privateKey` string
        - `privateKeyPass` string
        - `token` string
        - `refreshToken` string
        - `account` string, required
        - `requireUserCredentials` boolean
        - `authenticationType` 'password' | 'private_key' | 'sso' | 'external_browser' | 'oauth_authorization_code' | 'none'
        - `role` string
        - `threads` number, double
        - `clientSessionKeepAlive` boolean
        - `queryTag` string
        - `accessUrl` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `quotedIdentifiersIgnoreCase` boolean
        - `disableTimestampConversion` boolean
        - `timeoutSeconds` number, double
        - `override` boolean
        - `organizationWarehouseCredentialsUuid` string
        - `database` string
        - `warehouse` string
        - `schema` string
      - `status` 'deposited', required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)