Listar todas as categorias

GET

https://api.cubosuite.com.br/categories

Descrição

Retorna uma lista paginada de categorias da empresa do usuário autenticado, com suporte a filtros e ordenação.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cubosuite.com.br/categories?company_id=1&limit=10&page=1&orderColumn=created_at&orderDirection=asc'

Response Example

{
    "meta": {
        "total": 9,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "first_page": 1,
        "first_page_url": "/?page=1",
        "last_page_url": "/?page=1",
        "next_page_url": null,
        "previous_page_url": null
    },
    "data": [
        {
            "id": 300814,
            "name": "Adulto",
            "status": "active",
            "companyId": 1,
            "createdAt": "2024-11-07T10:49:38.000-03:00",
            "updatedAt": "2024-11-07T10:49:38.000-03:00",
            "products": [
                {
                    "id": 311940,
                    "name": "Bicicleta aro 15",
                    "sku": null,
                    "price": "600.00",
                    "status": "active",
                    "companyId": 1,
                    "createdAt": "2024-10-18T17:40:33.000-03:00",
                    "updatedAt": "2025-04-04T15:40:34.000-03:00",
                    "description": null,
                    "urlThumbnail": null,
                    "urlImage": null,
                    "showCard": 1,
                    "meta": {
                        "deleted_at": null,
                        "pivot_category_id": 300814,
                        "pivot_product_id": 311940
                    }
                },
                {
                    "id": 312614,
                    "name": "Monociclo 1",
                    "sku": null,
                    "price": "80.00",
                    "status": "active",
                    "companyId": 1,
                    "createdAt": "2024-12-10T10:32:34.000-03:00",
                    "updatedAt": "2024-12-13T11:52:04.000-03:00",
                    "description": null,
                    "urlThumbnail": null,
                    "urlImage": null,
                    "showCard": 0,
                    "meta": {
                        "deleted_at": null,
                        "pivot_category_id": 300814,
                        "pivot_product_id": 312614
                    }
                }
            ]
        },
        {
            "id": 301327,
            "name": "Apartamentos",
            "status": "active",
            "companyId": 1,
            "createdAt": "2025-05-30T13:40:18.000-03:00",
            "updatedAt": "2025-05-30T13:40:18.000-03:00",
            "products": [
                {
                    "id": 313641,
                    "name": "Apartamento JK",
                    "sku": null,
                    "price": "300000.00",
                    "status": "active",
                    "companyId": 1,
                    "createdAt": "2025-05-30T13:40:54.000-03:00",
                    "updatedAt": "2025-05-30T13:40:54.000-03:00",
                    "description": null,
                    "urlThumbnail": null,
                    "urlImage": null,
                    "showCard": 0,
                    "meta": {
                        "deleted_at": null,
                        "pivot_category_id": 301327,
                        "pivot_product_id": 313641
                    }
                }
            ]
        },
        {
            "id": 301393,
            "name": "Categoria",
            "status": "active",
            "companyId": 1,
            "createdAt": "2025-06-23T09:22:15.000-03:00",
            "updatedAt": "2025-06-23T09:22:15.000-03:00",
            "products": []
        },
        {
            "id": 300818,
            "name": "Elétrica",
            "status": "active",
            "companyId": 1,
            "createdAt": "2024-11-07T10:50:04.000-03:00",
            "updatedAt": "2024-11-07T10:50:04.000-03:00",
            "products": []
        },
        {
            "id": 300816,
            "name": "Esportiva",
            "status": "active",
            "companyId": 1,
            "createdAt": "2024-11-07T10:49:49.000-03:00",
            "updatedAt": "2024-11-07T10:49:49.000-03:00",
            "products": []
        },
        {
            "id": 300815,
            "name": "Infantil",
            "status": "active",
            "companyId": 1,
            "createdAt": "2024-11-07T10:49:44.000-03:00",
            "updatedAt": "2024-11-07T10:49:44.000-03:00",
            "products": []
        },
        {
            "id": 300817,
            "name": "Lazer",
            "status": "active",
            "companyId": 1,
            "createdAt": "2024-11-07T10:49:58.000-03:00",
            "updatedAt": "2024-11-07T10:49:58.000-03:00",
            "products": []
        }
      
    ]
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

company_id

integer

requerido

Exemplo:

limit

number

opcional

Número de itens por página (Padrão = 10 ou Max = 100).

Exemplo:

page

number

opcional

Página atual da paginação.

Exemplo:

orderColumn

string

opcional

Coluna utilizada para ordenação.

Exemplo:

created_at

orderDirection

string

opcional

Direção da ordenação (asc ou desc).

Exemplo:

asc

Respostas

🟢200Success

application/json

Body

Listar todas as categorias

Descrição#

Requisição

Respostas

Descrição