Obtener listado de Clientes

Este endpoint obtiene el listado de los clientes de su empresa en CMMShere

HTTP Request

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

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
codStringNo definidoSi se utiliza, el resultado solo incluirá clientes que contengan ese código
nombre_comercialStringNo definidoSi se utiliza, el resultado solo incluirá clientes que contengan ese nombre comercial
nombre_legalStringNo definidoSi se utiliza, el resultado solo incluirá clientes que contengan ese nombre legal
nro_identificacionStringNo definidoSi se utiliza, el resultado solo incluirá clientes que contengan esenro de identificación
offsetIntNo definidoOffset para paginación
limitIntNo definidoLimite para paginación
orderByArray["created_at", "desc"]Ordenamiento. El primer valor es el campo y el segundo la direccion ASC o DESC

Ejemplo de petición

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

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

{
    "success": true,
    "code": 200,
    "results": [
        {
            "id": 68,
            "cod": "C0000001",
            "com_name": "Donnelly, Reichel and Hirthe",
            "leg_name": "Emard, Kuvalis and Oberbrunner",
            "info": "CREDITO",
            "id_number": "1020397027",
            "client_type_id": "13",
            "address": "Avenida calles 13 y 14, Los Nardos, La Paz",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": "2110910",
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 69,
            "cod": "C0000002",
            "com_name": "Schulist Inc",
            "leg_name": "Stanton-Fritsch",
            "info": "EMBAJADA DE USA",
            "id_number": "99001",
            "client_type_id": "13",
            "address": "Avenida Arce N° 2780\r\nCasilla 425\r\nLa Paz",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": "(591) 22168000",
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 70,
            "cod": "C0000003",
            "com_name": "Grant Ltd",
            "leg_name": "Stroman-Dooley",
            "info": "Entidad Financiera",
            "id_number": "1020273023",
            "client_type_id": "23",
            "address": "Avenida Camacho N° 1355, Edificio Stephan y Cia., Pisos 2 al 4, zona Central",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": "2118878",
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 71,
            "cod": "C0000004",
            "com_name": "Witting PLC",
            "leg_name": "Bauch, Baumbach and Halvorson",
            "info": "BANCA Y FINANZAS",
            "id_number": "1016253021",
            "client_type_id": "23",
            "address": "AV. CAMACHO No. 1296 ESQUINA COLON ZONA CENTRAL",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 72,
            "cod": "C0000005",
            "com_name": "Tromp, Kunde and Homenick",
            "leg_name": "Towne, Lind and Williamson",
            "info": "Reaseguro contra riesgos y accidentes",
            "id_number": "1020655027",
            "client_type_id": "23",
            "address": "Av. Arce No. 2631 Torre Multicine, Piso 14, La Paz\r\nCalle Roberto Prudencio Nº 853 entre Calles 14 y 15 de Calacoto, La Paz\r\nAv. El Trompillo Nº 632, Santa Cruz de la Sierra",
            "country": "Bolivia",
            "city": "Santa Cruz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 73,
            "cod": "C0000006",
            "com_name": "Bins-Lang",
            "leg_name": "Paucek-Cassin",
            "info": "COMPAÑIA DE ENERGIA ELECTRICA",
            "id_number": "1020579023",
            "client_type_id": "13",
            "address": "Calle 15 de Calacoto Edificio Fergal No. 8089  primer Piso",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 74,
            "cod": "C0000007",
            "com_name": "Lubowitz-Bode",
            "leg_name": "Torphy, Hammes and Jaskolski",
            "info": "BANCO DEL AREA RURAL",
            "id_number": "1017083029",
            "client_type_id": "23",
            "address": "CALLE DEMETRIO CANELAS No. 27 ENTRE 16 Y 17 DE OBRAJES",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 75,
            "cod": "C0000008",
            "com_name": "Green-Wolf",
            "leg_name": "Wilderman, Hickle and Schimmel",
            "info": "DELEGACION DE LA UNION EUROPEA EN BOLIVIA",
            "id_number": "7",
            "client_type_id": "13",
            "address": "Avenida Costanera Nro 300, entre calles 10 y Nardos de Calacoto",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 76,
            "cod": "C0000009",
            "com_name": "Miller-Balistreri",
            "leg_name": "Okuneva, O'Keefe and Eichmann",
            "info": null,
            "id_number": "8",
            "client_type_id": "13",
            "address": ".",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        },
        {
            "id": 77,
            "cod": "C0000010",
            "com_name": "Marvin, Harvey and Cremin",
            "leg_name": "Runolfsdottir-Shields",
            "info": "Empresa Nacional de Telecomunicaciones",
            "id_number": "1020703023.",
            "client_type_id": "13",
            "address": "Calle Federico Zuazo esq. C. Tiawanaco",
            "country": "Bolivia",
            "city": "La Paz",
            "creator_id": 21,
            "status": "1",
            "email": null,
            "phone": null,
            "doc_type": "NIT",
            "created_at": "2021-07-13T17:03:35.000000Z"
        }
    ]
}