DocsDocsReference

Get a static listing

Retrieves a specific static listing by its ID

GET/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}

Retrieves a specific static listing by its ID

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/static-listings/\{listing_id\}
  • Summary: Get a static listing
  • Description: Retrieves a specific static listing by its ID
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
listing_idpathYesstringID of static listing
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses
StatusDescriptionContent
200static-listing retrieved successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
422Invalid request and not parsable by backendapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Static Listing

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Static Listing
PropertyTypeRequiredDetails
created_atstringNo-
idstringNo-
slugstringNo-
updated_atstringNo-
variantsobject[]No-
Static Listing Product Variant
PropertyTypeRequiredDetails
app_idstringNo-
custom_fieldsobjectNo-
idstringNo-
product_idstringNo-
product_namestringNo-
variant_namestringNo-
variant_numberstringNo-

Generated example (synthetic):

{
  "data": {
    "created_at": "string",
    "id": "string",
    "slug": "string",
    "updated_at": "string",
    "variants": [
      {
        "app_id": "string",
        "custom_fields": {},
        "id": "string",
        "product_id": "string",
        "product_name": "string",
        "variant_name": "string",
        "variant_number": "string"
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

422 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/static-listings/\{listing_id\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Static Listings
  • OpenAPI summary: Get a static listing

Get a static listing

# Get a static listing Retrieves a specific static listing by its ID
GET /api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}
Purpose

Retrieves a specific static listing by its ID

Required inputs

app_slug path team_slug path listing_id path

Primary response

200 ยท static-listing retrieved successfully

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}` - Summary: Get a static listing - Description: Retrieves a specific static listing by its ID - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | listing_id | path | Yes | string | ID of static listing | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | static-listing retrieved successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 422 | Invalid request and not parsable by backend | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Static Listing | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Static Listing | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `id` | string | No | - | | `slug` | string | No | - | | `updated_at` | string | No | - | | `variants` | object[] | No | - | ##### Static Listing Product Variant | Property | Type | Required | Details | | --- | --- | --- | --- | | `app_id` | string | No | - | | `custom_fields` | object | No | - | | `id` | string | No | - | | `product_id` | string | No | - | | `product_name` | string | No | - | | `variant_name` | string | No | - | | `variant_number` | string | No | - | **Generated example (synthetic):** ```json { "data": { "created_at": "string", "id": "string", "slug": "string", "updated_at": "string", "variants": [ { "app_id": "string", "custom_fields": {}, "id": "string", "product_id": "string", "product_name": "string", "variant_name": "string", "variant_number": "string" } ] }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 422 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/static-listings/{listing_id}` - OpenAPI tag: Static Listings - OpenAPI summary: Get a static listing