---
title: "✨ Get a saved interface"
method: GET
path: "/api/interfaces/{id}/"
tags: ["Interfaces"]
---

# ✨ Get a saved interface

`GET /api/interfaces/{id}/`

<Card href="https://humansignal.com/goenterprise">
        <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
        <p style="margin-top: 10px; font-size: 14px;">
            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
        </p>
    </Card>
Retrieve a saved interface by ID.

## Path parameters

- `id` integer, required

## Response `200`

- LseInterface
  - `artifacts` unknown
  - `code` string, required — JSX source code for the interface screen module
  - `compiled` string, required
  - `created_at` string, date-time, required
  - `created_by` UserSimple, required — A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations
    - `avatar` string, nullable, required
    - `email` string, email
    - `first_name` string
    - `id` integer, required
    - `last_name` string
    - `username` string, required
  - `data_sample` unknown
  - `description` string
  - `id` integer, required
  - `input_schema` unknown
  - `is_system` boolean, required — HumanSignal-provided system template visible to all organizations
  - `messages` unknown
  - `metadata` unknown
  - `output_schema` unknown
  - `projects_count` integer, required
  - `title` string, required
  - `updated_at` string, date-time, required
  - `versions` unknown
  - `workspace` integer, nullable

## Changes

- **2026-07-08** `b5f055b9d45b` — 1 breaking
  - the response property `created_by/allOf[#/components/schemas/UserSimple]/avatar` became nullable for the status `200`
- **2026-07-06** `c2893748a8d3` — 1 breaking
  - for the `path` request parameter `id`, the type/format was changed from `string`/`` to `integer`/``
- **2026-05-05** `b7b3b45888a8` — 1 info
  - added the optional property `metadata` to the response with the `200` status

[Change history](https://skmtc.dev/humansignal/apis/label-studio-api/changes/api/interfaces/:id/get.md)

---

[API](https://skmtc.dev/humansignal/apis/label-studio-api.md) · [All operations](https://skmtc.dev/humansignal/apis/label-studio-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/humansignal/label-studio-api/revisions/93493def8bb7/schema)