Interfaces

✨ List saved interfaces

<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> List saved interfaces for the current organization.
get/api/interfaces/

Query parameters

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

scopestring
searchstring

A search term.

workspaceinteger

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

Changed in 5 of the 97 revisions of this API.558

    • the response property results/items/created_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • the results/items/versions response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • added the new optional query request parameter scope

      new-optional-request-parameter

    • added the new optional query request parameter workspace

      new-optional-request-parameter

  • 915403834247122See the full diff
    • removed the required property results/items/code from the response with the 200 status

      response-required-property-removed

    • removed the optional property results/items/input_schema from the response with the 200 status

      response-optional-property-removed

    • removed the optional property results/items/output_schema from the response with the 200 status

      response-optional-property-removed

    • added the optional property results/items/published_versions_count to the response with the 200 status

      response-optional-property-added

    • added the optional property results/items/type_name to the response with the 200 status

      response-optional-property-added

  • 4d2f235ae6c4232See the full diff
    • the results/items/versions response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • removed the required property results/items/compiled from the response with the 200 status

      response-required-property-removed

    • removed the optional property results/items/artifacts from the response with the 200 status

      response-optional-property-removed

    • removed the optional property results/items/data_sample from the response with the 200 status

      response-optional-property-removed

    • removed the optional property results/items/messages from the response with the 200 status

      response-optional-property-removed

    • the response optional property results/items/versions became read-only for the status 200

      response-optional-property-became-read-only

    • the response property results/items/versions became required for the status 200

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter search

      new-optional-request-parameter

    • added the optional property results/items/metadata to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.