> 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

## Get My Organization

> Returns the authenticated organization's data.

```json
{"openapi":"3.0.3","info":{"title":"Zipnova Rutas Org API","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{organization}.routes.zipnova.com/api/v1","variables":{"organization":{"default":"mi-organizacion","description":"Organization subdomain"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","bearerFormat":"5|sdmnakj32e90ansaIKJNe20Jasaaxzaxx2","scheme":"bearer"}},"schemas":{"Organization":{"type":"object","properties":{"id":{"type":"string","format":"ulid","description":"Organization ULID"},"name":{"type":"string"},"subdomain":{"type":"string"},"custom_domain":{"type":"string","nullable":true},"locale":{"type":"string"},"timezone":{"type":"string"},"currency":{"type":"string"},"suspended_at":{"type":"string","format":"date-time","nullable":true},"operational_address_id":{"type":"string","format":"ulid","nullable":true}}}}},"paths":{"/organizations/my":{"get":{"tags":["Organizations"],"summary":"Get My Organization","description":"Returns the authenticated organization's data.","operationId":"getMyOrganization","responses":{"200":{"description":"Organization retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"$ref":"#/components/schemas/Organization"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}}}
```

## List My Organization Places

> Returns all operational places belonging to the authenticated organization.

```json
{"openapi":"3.0.3","info":{"title":"Zipnova Rutas Org API","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{organization}.routes.zipnova.com/api/v1","variables":{"organization":{"default":"mi-organizacion","description":"Organization subdomain"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","bearerFormat":"5|sdmnakj32e90ansaIKJNe20Jasaaxzaxx2","scheme":"bearer"}},"schemas":{"Place":{"type":"object","properties":{"id":{"type":"string","format":"ulid"},"org_id":{"type":"integer"},"name":{"type":"string"},"street":{"type":"string"},"street_number":{"type":"string"},"floor":{"type":"string","nullable":true},"apartment":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"phone_raw":{"type":"string"},"phone":{"type":"string","description":"Phone in E.164 format"},"email":{"type":"string","nullable":true},"zipcode":{"type":"string","nullable":true},"city":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"state":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}},"country":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}}},"paths":{"/organizations/my/places":{"get":{"tags":["Organizations"],"summary":"List My Organization Places","description":"Returns all operational places belonging to the authenticated organization.","operationId":"getMyOrganizationPlaces","responses":{"200":{"description":"Places retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"places":{"type":"array","items":{"$ref":"#/components/schemas/Place"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}}}
```

## List My Organization Contracts

> Returns paginated list of organizations that have a contract with the authenticated organization. Use \`license=carrier\` to list shippers (when the authenticated org is a carrier), or \`license=shipper\` (default) to list carriers.

```json
{"openapi":"3.0.3","info":{"title":"Zipnova Rutas Org API","version":"1.0.0"},"tags":[{"name":"Organizations","description":"Información de la organización autenticada"}],"servers":[{"url":"https://{organization}.routes.zipnova.com/api/v1","variables":{"organization":{"default":"mi-organizacion","description":"Organization subdomain"}}}],"security":[{"orgToken":[]}],"components":{"securitySchemes":{"orgToken":{"type":"http","bearerFormat":"5|sdmnakj32e90ansaIKJNe20Jasaaxzaxx2","scheme":"bearer"}},"schemas":{"Organization":{"type":"object","properties":{"id":{"type":"string","format":"ulid","description":"Organization ULID"},"name":{"type":"string"},"subdomain":{"type":"string"},"custom_domain":{"type":"string","nullable":true},"locale":{"type":"string"},"timezone":{"type":"string"},"currency":{"type":"string"},"suspended_at":{"type":"string","format":"date-time","nullable":true},"operational_address_id":{"type":"string","format":"ulid","nullable":true}}},"Pagination":{"type":"object","properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"last_page":{"type":"integer"}}}}},"paths":{"/organizations/my/contracts":{"get":{"tags":["Organizations"],"summary":"List My Organization Contracts","description":"Returns paginated list of organizations that have a contract with the authenticated organization. Use `license=carrier` to list shippers (when the authenticated org is a carrier), or `license=shipper` (default) to list carriers.","operationId":"getMyOrganizationContracts","parameters":[{"name":"license","in":"query","schema":{"type":"string","enum":["shipper","carrier"],"default":"shipper"},"description":"Filter perspective: `shipper` lists the carriers contracted, `carrier` lists the shippers contracted."},{"name":"perPage","in":"query","schema":{"type":"integer","default":10},"description":"Number of results per page"},{"name":"sort","in":"query","schema":{"type":"string","enum":["organizations.name","-organizations.name","markets.name","-markets.name"],"default":"organizations.name"},"description":"Sort field (prefix with `-` for descending)"},{"name":"filter[global]","in":"query","schema":{"type":"string"},"description":"Global search across organization name and market name"},{"name":"filter[organizations.name]","in":"query","schema":{"type":"string"},"description":"Filter by organization name"},{"name":"filter[markets.name]","in":"query","schema":{"type":"string"},"description":"Filter by market name"}],"responses":{"200":{"description":"Contracts retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"organizations":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}}}
```

## Modelos

## The Organization object

```json
{"openapi":"3.0.3","info":{"title":"Zipnova Rutas Org API","version":"1.0.0"},"components":{"schemas":{"Organization":{"type":"object","properties":{"id":{"type":"string","format":"ulid","description":"Organization ULID"},"name":{"type":"string"},"subdomain":{"type":"string"},"custom_domain":{"type":"string","nullable":true},"locale":{"type":"string"},"timezone":{"type":"string"},"currency":{"type":"string"},"suspended_at":{"type":"string","format":"date-time","nullable":true},"operational_address_id":{"type":"string","format":"ulid","nullable":true}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zipnova.com/rutas/api/organizaciones.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.