API Reference

Listado de Tipos de Cliente

Este endpoint obtiene el listado de los tipos de cliente

HTTP Request

GET https://admin.cmmshere.com/api/v1/clientTypes

Parámetros de consulta

Estos parámetros son opcionales y utilizados para filtrar e interactuar con la información obtenida. Los parámetros de filtrado (si se utilizan) se usan para buscar resultados que contengan dicho texto.

ParámetroTipoDefaultDescripción
nameStringNo definidoNombre del tipo de cliente
descriptionStringNo definidoDescripción del tipo de cliente
offsetIntNo definidoOffset para paginación
limitIntNo definidoLímite para paginación
orderByArray["created_at", "desc"]Ordenamiento. El primer valor es el campo y el segundo la dirección ASC o DESC

Ejemplo de petición

curl --location --request GET 'https://admin.cmmshere.com/api/v1/clientTypes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 804|fCkDcz43egLAubMzPinRCIVUIjPUsGkvbVJ864IP' \
--header 'Cookie: XSRF-TOKEN=eyJpdiI6IktwckY2VTNIOU5UYVZvUjg5eUxXV2c9PSIsInZhbHVlIjoiOTlpVEZIVGRnZEJoRnN3RnpVK3lLMjZZQnBHVGFrc2VNZU5XVUplamswTjl1RC8yVk1JY0lUWGVSVDlIN0YxZnEzQldLQjRyUUFmTEQ2WWFhbDNDNXVVSTZ2QVg2aEkxTTNaZWI3NzlvZVJGV3dmRlFXUU5qVWhhelFCOFpRaTgiLCJtYWMiOiIwMzU2Y2YyNTk5YjE2ZmYyN2Y4MmJkMzQyNjg4MTU2MGJjZjY1MWZjYTAxMDdjNjlkYTkxYjIzZTkwZjZlMmZhIn0%3D; laravel_session=eyJpdiI6IkpMOHR1c3pYOHpXem9vZmhUa0RqUXc9PSIsInZhbHVlIjoiWGY3RGlUV3A3WGJyQ3JvZ29nWVdYWFRtbFA5U0VmU3RLdmVuMVZQcEMwa3B4VGlYb1M2SG5TYTA5U1hxclJNT2tyRDdoanhqWVFITHB3SEdENzZzaTl5RlBZR3hOc2VJNGQzczVxZDdTNC9pMVRobXBTckM4emlzTWtNNjFGS1kiLCJtYWMiOiIyZGZkODQ2YjI2YmU0NGUyYmU0YTAwNTBiNDk3ODU2MTMwMjEyOGUyOGE0YzIzOTMzZjAxZGQzMGY0MGVkOGU1In0%3D' \
--data '{
    "offset" : 0,
    "limit" : 5,
    "orderBy" : ["id", "desc"]
}'

La petición de arriba devuelve un JSON estructurado de la siguiente manera

{
    "success": true,
    "code": 200,
    "results": [
        {
            "id": 48,
            "creator_id": 30,
            "name": "nombre de tipo modificado",
            "description": "descripcion de tipo modificada",
            "created_at": "2023-09-11T21:18:21.000000Z"
        },
        {
            "id": 24,
            "creator_id": 56,
            "name": "Distribuidor",
            "description": null,
            "created_at": "2021-08-17T19:00:31.000000Z"
        },
        {
            "id": 23,
            "creator_id": 56,
            "name": "Cliente Final",
            "description": null,
            "created_at": "2021-08-17T19:00:03.000000Z"
        },
        {
            "id": 22,
            "creator_id": 57,
            "name": "Integrador",
            "description": "..",
            "created_at": "2021-07-30T14:33:05.000000Z"
        },
        {
            "id": 13,
            "creator_id": 21,
            "name": "General",
            "description": "General",
            "created_at": "2021-06-16T20:37:20.000000Z"
        }
    ]
}