GET/api/v4/sub-categories

Listar subcategorías

Devuelve el catálogo completo de subcategorías que se utilizan para clasificar las ubicaciones al crearlas o actualizarlas.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Este endpoint no recibe parámetros.

Respuestas

200The full list of subcategory objects.
Response
{  "data": {    "subcategories": [      {        "databaseId": 639,        "id": "U3ViQ2F0ZWdvcnk6NjM5",        "key": "3d-printing",        "name": "3D Printing",        "primary": true      },      {        "databaseId": 4589,        "id": "U3ViQ2F0ZWdvcnk6NDU4OQ==",        "key": "3d-printing-service",        "name": "3D printing service",        "primary": true      },      {        "databaseId": 3268,        "id": "U3ViQ2F0ZWdvcnk6MzI2OA==",        "key": "aadhaar-center",        "name": "Aadhaar center",        "primary": true      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Devuelve el catálogo completo de subcategorías que clasifican la actividad comercial de una ubicación. Esta cuenta devuelve aproximadamente 6,000 entradas, así que trátalo como un catálogo de consulta extenso y mayormente estático, recupéralo una vez, guárdalo en caché y actualízalo periódicamente en lugar de consultarlo durante cada operación de creación o actualización.

Cada elemento contiene:

  • databaseId: el número entero que debes pasar como subCategoryId al crear o actualizar una ubicación e incluir en el array additionalCategoryIds para las categorías complementarias.
  • id: el identificador Relay codificado en Base64 del mismo registro.
  • key: un slug del nombre de la categoría apto para URL.
  • name: la etiqueta legible para las personas.
  • primary: indica si la categoría puede ser la subcategoría principal de una ubicación.

Resolver una categoría antes de crear una ubicación

Al dar de alta una ubicación, normalmente conoces el tipo de negocio como texto libre ("servicio de impresión 3D"), pero createLocation espera un subCategoryId numérico. El procedimiento es: recupera esta lista una vez, crea un mapa name → databaseId en tu propio código y luego busca el id en el momento de la creación.

JavaScript
const res = await fetch('https://listingsapi.com/api/v4/sub-categories', {  headers: { Authorization: 'API ' + process.env.LISTINGSAPI_KEY },});const { data } = await res.json();const byName = new Map(data.subcategories.map((s) => [s.name.toLowerCase(), s.databaseId])); const subCategoryId = byName.get('3d printing service'); // 4589

Para etiquetar una ubicación con más de una categoría, pasa la principal en subCategoryId y hasta 9 ids complementarios en additionalCategoryIds. Consulta Crear una ubicación y Actualizar una ubicación para saber cómo se utilizan estos campos.

La respuesta es un único array sin paginación. Cuenta para el límite de solicitudes de tu cuenta como cualquier otra llamada, así que guárdala en caché en lugar de volver a recuperarla para cada ubicación; una respuesta 429 incluye una cabecera Retry-After.

Request
curl -X GET 'https://listingsapi.com/api/v4/sub-categories' \  -H "Authorization: API $LISTINGSAPI_KEY"