---
updatedAt: 2025-09-10T20:58:45.000Z
agentTools:
  projectIndex: https://shipcars.readme.io/llms.txt
---

# Get user linked companies

Returns all linked companies to a user.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "User Management",
    "description": "Ship.Cars User Management",
    "contact": {
      "url": "https://ship.cars",
      "email": "support@ship.cars"
    },
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://ship.cars/api"
    }
  ],
  "paths": {
    "/usermanagement/v2/users/current/linked-companies": {
      "get": {
        "tags": [
          "Users API"
        ],
        "summary": "Get user linked companies",
        "description": "Returns all linked companies to a user.",
        "operationId": "getLinkedCompanies",
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "name"
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number (1..N)",
            "schema": {
              "minimum": 1,
              "type": "integer",
              "default": 1
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The size of the page to be returned",
            "schema": {
              "minimum": 1,
              "type": "integer",
              "default": 25
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorting criteria in the format: property(asc|desc). Multiple sort criteria are supported.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "default": [
                "name,asc"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "totalPages": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "totalElements": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "page": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "size": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "content": {
                      "type": "array",
                      "items": {
                        "required": [
                          "name"
                        ],
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU"
                          },
                          "active": {
                            "type": "boolean",
                            "description": "Whether the company is active or not",
                            "example": true
                          },
                          "name": {
                            "type": "string",
                            "example": "John Smith"
                          },
                          "companyType": {
                            "type": "string",
                            "example": "SHIPPER",
                            "enum": [
                              "SHIPPER",
                              "CARRIER",
                              "API_INTEGRATOR"
                            ]
                          },
                          "companySubtype": {
                            "type": "string",
                            "example": "BROKER",
                            "enum": [
                              "DEALER",
                              "AUCTION",
                              "BROKER",
                              "CARRIER",
                              "PRIVATE"
                            ]
                          },
                          "usDotNumber": {
                            "type": "string",
                            "example": "1234567"
                          },
                          "logoUrl": {
                            "type": "string",
                            "description": "URL of the logo",
                            "example": "https://image.com/logo.jpg"
                          },
                          "email": {
                            "type": "string",
                            "example": "email@email.com"
                          },
                          "accountingEmail": {
                            "type": "string",
                            "example": "email@email.com"
                          },
                          "parentCompanyId": {
                            "type": "string",
                            "example": "C-KHDBCYFIUVCBLBVNIXDAVTS6UU"
                          },
                          "createdAt": {
                            "type": "string",
                            "description": "Created at",
                            "format": "date-time",
                            "example": "2023-05-09T08:45:00Z"
                          },
                          "lastModified": {
                            "type": "string",
                            "description": "Last modified",
                            "format": "date-time",
                            "example": "2023-05-09T10:12:00Z"
                          }
                        }
                      }
                    },
                    "first": {
                      "type": "boolean"
                    },
                    "last": {
                      "type": "boolean"
                    },
                    "hasPrevious": {
                      "type": "boolean"
                    },
                    "hasNext": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "httpStatus": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorCode": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorMessage": {
                      "type": "string"
                    },
                    "errorDetails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```