data—Optional← HomeFleetPay / API
List active links and negotiations with transport managers
Parameters, data structure and responses from the versioned contract.
GET
/embarcador/solicitacoes-transporte/vinculos-gestoresTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Lists transport managers and commercial parameters enabled for the authenticated shipper to create transport requests.
Authentication
- Required Scope
operacao— Operations- Module
- Direct Contracting (Shipper)
- Target Profiles
- Shipper · Transport Manager · Dedicated Fleet Contractor
- Schemes
- OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
No parameters declared for this operation.
Responses
200 HTTP Response
Operation processed successfully.
application/json
metaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP Response
Missing, invalid or cross-environment credential.
403 HTTP Response
Dashboard scope not enabled or resource outside company scope.
Complete Operation Definition
{
"tags": [
"Solicitações e Contratação de Transporte (Embarcador)"
],
"operationId": "listarVinculosGestoresEmbarcador",
"summary": "Listar vínculos e negociações ativas com gestores",
"description": "Lista gestores de transporte e parâmetros comerciais habilitados para o embarcador autenticado criar solicitações de transporte.",
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "contratacao-direta",
"x-fleetpay-profiles": [
"embarcador",
"gestor",
"agregado_empresarial"
],
"method": "GET",
"path": "/embarcador/solicitacoes-transporte/vinculos-gestores",
"parameters": []
}