Responses

List Responses

get

List all Responses items.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

Query parameters

afterstringOptional

Cursor for pagination (item ID)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (default: 50, max: 1000)

Default: 50

sortany ofOptional

Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)

stringOptional

or

string[]Optional

Responses

200

List of Responses

application/json

Responses collection

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/v2/catalog/versions/{versionId}/responses

GET /v2/catalog/versions/{versionId}/responses HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [],
  "pagination": {
    "nextCursor": null,
    "hasMore": true,
    "limit": 1
  }
}

Create Response

post

Create a new Response item.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Response created

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/v2/catalog/versions/{versionId}/responses

POST /v2/catalog/versions/{versionId}/responses HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Response

get

Get a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Response details

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

get/v2/catalog/versions/{versionId}/responses/{id}

GET /v2/catalog/versions/{versionId}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Response

post

Completely replaces a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Response replaced

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

201

Response created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

post/v2/catalog/versions/{versionId}/responses/{id}

POST /v2/catalog/versions/{versionId}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Response

delete

Delete a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Response deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

delete/v2/catalog/versions/{versionId}/responses/{id}

DELETE /v2/catalog/versions/{versionId}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Response

patch

Partially updates a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3cmc7qj2myaExample: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Response updated

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

patch/v2/catalog/versions/{versionId}/responses/{id}

PATCH /v2/catalog/versions/{versionId}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Responses

get

List all Responses items.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

Query parameters

afterstringOptional

Cursor for pagination (item ID)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (default: 50, max: 1000)

Default: 50

sortany ofOptional

Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)

stringOptional

or

string[]Optional

Responses

200

List of Responses

application/json

Responses collection

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses

GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [],
  "pagination": {
    "nextCursor": null,
    "hasMore": true,
    "limit": 1
  }
}

Create Response

post

Create a new Response item.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

Body

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Response created

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses

POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Response

get

Get a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Response details

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

get/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}

GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Response

post

Completely replaces a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Response replaced

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

201

Response created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

post/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}

POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Response

delete

Delete a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Response deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

delete/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}

DELETE /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Response

patch

Partially updates a Response item by its id.

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Response identifier

Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3dhsjonvn4qExample: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Response updated

application/json

Response is an operation response entry including status code, MIME type, payload shape, examples, and headers.

idstring · min: 30 · max: 30Optional

Object ID with prefix "res_"

Default: res_agqatw3xir2znbb3bodhkwn6z4Example: res_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

statusCodenumber · nullableOptional

HTTP status code; null denotes the default response.

Example: 200

descriptionstringOptional

Markdown description of the response.

Example: Successful response with user data.

descriptionBlocksany ofOptional

Response description in ProseMirror JSON format.

Example: {"type":"paragraph","content":[{"type":"text","text":"Response description in rich text format."}]}

or

contentMediaTypestring · nullableOptional

MIME type of the response body (for example, application/json); null means the response has no body.

Example: application/json

schemaany ofOptional

Structured shape of the response payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Response not found

application/json

500

Internal Server Error

application/json

patch/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}

PATCH /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "res_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "statusCode": 200,
  "description": "Successful response with user data.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Response description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "examples": {},
  "kvStorage": {},
  "headers": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}