> For the complete documentation index, see [llms.txt](https://docs.zipnova.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zipnova.com/rutas/api/organizaciones.md).

# Organizaciones

## Endpoints

## Obtener mi organización

> Retorna los datos de la organización autenticada (la que corresponde al token Bearer utilizado).

```json
{"openapi":"3.0.0","info":{"title":"Zipnova Rutas API Organizacional","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{subdomain}.routes.zipnova.app/api/v1","description":"API organizacional de Zipnova Rutas","variables":{"subdomain":{"default":"mi-organizacion","description":"Subdominio de la organización (ej: mi-empresa, logistica-sur)"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","description":"Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.","bearerFormat":"API Token","scheme":"bearer"}},"schemas":{"Organization":{"description":"Organización registrada en Zipnova Rutas","properties":{"id":{"description":"Identificador público de la organización (con prefijo `org_`).","type":"string"},"name":{"description":"Nombre de la organización.","type":"string"},"subdomain":{"description":"Subdominio de la organización.","type":"string"},"custom_domain":{"description":"Dominio personalizado.","type":"string","nullable":true},"locale":{"description":"Locale por defecto.","type":"string"},"timezone":{"description":"Zona horaria de la organización.","type":"string"},"currency":{"description":"Moneda por defecto.","type":"string"},"suspended_at":{"description":"Fecha de suspensión si aplica.","type":"string","format":"date-time","nullable":true},"operational_address_id":{"description":"ID del domicilio operativo (con prefijo `ple_`).","type":"string","nullable":true}},"type":"object"}}},"paths":{"/organizations/my":{"get":{"tags":["Organizations"],"summary":"Obtener mi organización","description":"Retorna los datos de la organización autenticada (la que corresponde al token Bearer utilizado).","operationId":"getMyOrganization","responses":{"200":{"description":"Datos de la organización","content":{"application/json":{"schema":{"properties":{"organization":{"$ref":"#/components/schemas/Organization"}},"type":"object"}}}},"401":{"description":"No autenticado"},"403":{"description":"Sin permisos"}}}}}}
```

## Listar lugares de la organización

> Retorna todos los lugares operativos (depósitos, sucursales, puntos de retiro) guardados en la organización.

```json
{"openapi":"3.0.0","info":{"title":"Zipnova Rutas API Organizacional","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{subdomain}.routes.zipnova.app/api/v1","description":"API organizacional de Zipnova Rutas","variables":{"subdomain":{"default":"mi-organizacion","description":"Subdominio de la organización (ej: mi-empresa, logistica-sur)"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","description":"Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.","bearerFormat":"API Token","scheme":"bearer"}},"schemas":{"Place":{"description":"Lugar guardado de la organización (punto operativo)","properties":{"id":{"description":"Identificador del lugar (con prefijo `ple_`).","type":"string"},"org_id":{"description":"ID interno de la organización propietaria.","type":"integer"},"name":{"description":"Nombre del lugar.","type":"string"},"street":{"type":"string","nullable":true},"street_number":{"type":"string","nullable":true},"floor":{"type":"string","nullable":true},"apartment":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"phone_raw":{"description":"Teléfono sin formato E.164.","type":"string","nullable":true},"phone":{"description":"Teléfono en formato E.164.","type":"string","nullable":true},"email":{"type":"string","format":"email","nullable":true},"zipcode":{"type":"string","nullable":true},"city":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"state":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"},"country":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"}}},"paths":{"/organizations/my/places":{"get":{"tags":["Organizations"],"summary":"Listar lugares de la organización","description":"Retorna todos los lugares operativos (depósitos, sucursales, puntos de retiro) guardados en la organización.","operationId":"getMyOrganizationPlaces","responses":{"200":{"description":"Lista de lugares","content":{"application/json":{"schema":{"properties":{"places":{"type":"array","items":{"$ref":"#/components/schemas/Place"}}},"type":"object"}}}},"401":{"description":"No autenticado"},"403":{"description":"Sin permisos"}}}}}}
```

## Listar contratos de la organización

> Retorna las organizaciones con las que existe un contrato activo.\
> Permite filtrar por tipo de licencia (\`shipper\` o \`carrier\`), ordenar y paginar resultados.

```json
{"openapi":"3.0.0","info":{"title":"Zipnova Rutas API Organizacional","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{subdomain}.routes.zipnova.app/api/v1","description":"API organizacional de Zipnova Rutas","variables":{"subdomain":{"default":"mi-organizacion","description":"Subdominio de la organización (ej: mi-empresa, logistica-sur)"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","description":"Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.","bearerFormat":"API Token","scheme":"bearer"}},"schemas":{"Organization":{"description":"Organización registrada en Zipnova Rutas","properties":{"id":{"description":"Identificador público de la organización (con prefijo `org_`).","type":"string"},"name":{"description":"Nombre de la organización.","type":"string"},"subdomain":{"description":"Subdominio de la organización.","type":"string"},"custom_domain":{"description":"Dominio personalizado.","type":"string","nullable":true},"locale":{"description":"Locale por defecto.","type":"string"},"timezone":{"description":"Zona horaria de la organización.","type":"string"},"currency":{"description":"Moneda por defecto.","type":"string"},"suspended_at":{"description":"Fecha de suspensión si aplica.","type":"string","format":"date-time","nullable":true},"operational_address_id":{"description":"ID del domicilio operativo (con prefijo `ple_`).","type":"string","nullable":true}},"type":"object"},"Pagination":{"description":"Metadatos de paginación","properties":{"total":{"description":"Total de registros.","type":"integer"},"per_page":{"description":"Registros por página.","type":"integer"},"current_page":{"description":"Página actual.","type":"integer"},"last_page":{"description":"Última página.","type":"integer"},"from":{"description":"Índice del primer registro de la página.","type":"integer"},"to":{"description":"Índice del último registro de la página.","type":"integer"}},"type":"object"}}},"paths":{"/organizations/my/contracts":{"get":{"tags":["Organizations"],"summary":"Listar contratos de la organización","description":"Retorna las organizaciones con las que existe un contrato activo.\nPermite filtrar por tipo de licencia (`shipper` o `carrier`), ordenar y paginar resultados.","operationId":"getMyOrganizationContracts","parameters":[{"name":"license","in":"query","description":"Tipo de licencia: `shipper` (remitentes con los que opero como carrier) o `carrier` (transportistas que me atienden como shipper). Por defecto: `shipper`.","required":false,"schema":{"type":"string","enum":["shipper","carrier"]}},{"name":"filter[global]","in":"query","description":"Búsqueda por nombre de organización o mercado.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Campo de ordenamiento. Prefijo `-` para descendente.","required":false,"schema":{"type":"string","enum":["organizations.name","-organizations.name","markets.name","-markets.name"]}},{"name":"perPage","in":"query","description":"Cantidad de resultados por página.","required":false,"schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Lista paginada de organizaciones con contrato","content":{"application/json":{"schema":{"properties":{"organizations":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"links":{"properties":{"first":{"type":"string","format":"uri","nullable":true},"last":{"type":"string","format":"uri","nullable":true},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}},"type":"object"},"meta":{"$ref":"#/components/schemas/Pagination"}},"type":"object"}},"type":"object"}}}},"401":{"description":"No autenticado"},"403":{"description":"Sin permisos"}}}}}}
```

## Modelos

## The Organization object

```json
{"openapi":"3.0.0","info":{"title":"Zipnova Rutas API Organizacional","version":"1.0.0"},"components":{"schemas":{"Organization":{"description":"Organización registrada en Zipnova Rutas","properties":{"id":{"description":"Identificador público de la organización (con prefijo `org_`).","type":"string"},"name":{"description":"Nombre de la organización.","type":"string"},"subdomain":{"description":"Subdominio de la organización.","type":"string"},"custom_domain":{"description":"Dominio personalizado.","type":"string","nullable":true},"locale":{"description":"Locale por defecto.","type":"string"},"timezone":{"description":"Zona horaria de la organización.","type":"string"},"currency":{"description":"Moneda por defecto.","type":"string"},"suspended_at":{"description":"Fecha de suspensión si aplica.","type":"string","format":"date-time","nullable":true},"operational_address_id":{"description":"ID del domicilio operativo (con prefijo `ple_`).","type":"string","nullable":true}},"type":"object"}}}}
```