Skip to main content
GET
/
app-data-schemas
/
{idOrKey}
Get app data schema by selector
curl --request GET \
  --url https://api.getmembrane.com/app-data-schemas/{idOrKey} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "uuid": "<string>",
  "key": "<string>",
  "description": "<string>",
  "meta": {},
  "state": "BUILDING",
  "errors": [
    {
      "message": "<string>",
      "type": "bad_request",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    }
  ],
  "revision": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "archivedAt": "<string>",
  "isDeactivated": true,
  "isReadOnly": true,
  "instanceKey": "<string>",
  "appDataSchemaId": "<string>",
  "schema": {},
  "code": "<string>",
  "userId": "<string>",
  "tenantId": "<string>",
  "appDataSchemaRevision": "<string>",
  "isCustomized": true,
  "error": {
    "message": "<string>",
    "type": "bad_request",
    "key": "<string>",
    "data": {},
    "stack": {},
    "causedByError": "<unknown>",
    "logs": [
      {}
    ]
  },
  "user": {},
  "appDataSchema": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
idOrKey
string
required

App data schema ID or key

Query Parameters

​
search
string

Text search query to filter results

​
limit
integer

Maximum number of items to return (1-1000)

Required range: 1 <= x <= 1000
​
cursor
string

Pagination cursor from a previous response

​
includeArchived
boolean
​
isUniversal
boolean
​
tenantId
string
​
userId
string
​
appDataSchemaId
string
​
instanceKey
string

Response

200 - application/json
​
id
string
required

Internal database ID of the element. Assigned by the API; unique per element.

​
name
string
required

Display name. Always present in API responses (filled by API if not set on create).

​
uuid
string

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

​
key
string

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

​
description
string

Optional human-readable description.

​
meta
object

Optional key-value metadata.

​
state
enum<string>

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

Available options:
BUILDING,
CLIENT_ACTION_REQUIRED,
CONFIGURATION_ERROR,
SETUP_FAILED,
READY,
DISCONNECTING
​
errors
object[]

Validation or setup errors when state is not READY.

​
revision
string

Opaque revision token; changes on each update. Used for optimistic concurrency.

​
createdAt
string

ISO date when the element was created.

​
updatedAt
string

ISO date when the element was last updated.

​
archivedAt
string
​
isDeactivated
boolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

​
isReadOnly
boolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

​
instanceKey
string
​
appDataSchemaId
string
​
schema
object
​
code
string
​
userId
string
​
tenantId
string
​
appDataSchemaRevision
string
​
isCustomized
boolean
​
error
object
​
user
object
​
appDataSchema
object