---
title: "Get a tenant by id"
method: GET
path: "/v1/tenants/{tenantId}"
tags: ["TenantQuery"]
---

# Get a tenant by id

`GET /v1/tenants/{tenantId}`

## Path parameters

- `tenantId` string, required

## Response `200`

A successful response.

- TenantqueryserviceGetByIdResponse
  - `tenantId` string
  - `metadata` TenanteventMetadataSet
    - `name` string
    - `description` string
    - `timezoneDesignatorIana` string
    - `firstDayOfWeek` 'SUNDAY' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY'
  - `state` 'NOT_EXIST' | 'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'
  - `version` integer
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `availableCommands` TenantcommandAvailableCommand[]
    - `command` 'CREATE' | 'ACTIVATE' | 'DEACTIVATE' | 'ARCHIVE' | 'SET_METADATA' | 'SET_PROMOTION_PROPERTY_SCHEMA' | 'SET_CUSTOMER_PROPERTY_SCHEMA' | 'MERGE_AMOUNT_REWARD_TYPES' | 'MERGE_UNIT_REWARD_TYPES' | 'MERGE_PROMOTION_PROPERTY_SCHEMAS' | 'MERGE_CUSTOMER_PROPERTY_SCHEMAS' | 'MERGE_SESSION_PROPERTY_SCHEMAS' | 'SET_LICENSE_TERMS'
    - `url` string
    - `httpMethod` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
  - `customerPropertiesSchema` object
  - `promotionPropertiesSchema` object
  - `sessionPropertiesSchema` object

## Other responses

- `default` — An unexpected error response.

---

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