---
updatedAt: 2026-04-21T06:16:37.000Z
agentTools:
  projectIndex: https://b2brouter.readme.io/llms.txt
---

# List configured transports

This endpoint list all transports this account has configured.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "B2Brouter API",
    "description": "The B2Brouter API allows you to send and receive electronic documents.",
    "version": "2026-06-26",
    "contact": {
      "name": "Service Delivery Team",
      "email": "servicedelivery@b2brouter.net"
    }
  },
  "servers": [
    {
      "url": "https://api-staging.b2brouter.net",
      "description": "Test server"
    },
    {
      "url": "https://api.b2brouter.net",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Transports",
      "description": "Related to transport configurations"
    }
  ],
  "paths": {
    "/accounts/{account}/transports": {
      "get": {
        "operationId": "get-transports",
        "tags": [
          "Transports"
        ],
        "summary": "List configured transports",
        "description": "This endpoint list all transports this account has configured.",
        "parameters": [
          {
            "$ref": "#/components/parameters/api_version_header"
          },
          {
            "$ref": "#/components/parameters/account"
          },
          {
            "$ref": "#/components/parameters/offset"
          },
          {
            "$ref": "#/components/parameters/limit"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "transports": {
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "$ref": "#/components/schemas/TransportB2brouter"
                          },
                          {
                            "$ref": "#/components/schemas/TransportEmail"
                          },
                          {
                            "$ref": "#/components/schemas/TransportPeppol"
                          },
                          {
                            "$ref": "#/components/schemas/TransportUserPassword"
                          },
                          {
                            "$ref": "#/components/schemas/TransportEdi"
                          }
                        ]
                      }
                    },
                    "meta": {
                      "$ref": "#/components/schemas/IndexMeta"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "description": "API Key of your account",
        "name": "X-B2B-API-Key",
        "in": "header"
      }
    },
    "parameters": {
      "api_version_header": {
        "name": "X-B2B-API-Version",
        "in": "header",
        "description": "Specifies the version of the API to use in this request. If not specified uses the API-Version set in the group conifguration\nB2Brouter UI Application -> Developers -> API Keys -> API Version\n",
        "required": false,
        "schema": {
          "type": "string",
          "example": "2026-06-26",
          "default": "2026-06-26"
        }
      },
      "offset": {
        "name": "offset",
        "description": "Jump to the first object.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 0,
          "example": 0
        }
      },
      "limit": {
        "name": "limit",
        "description": "Number of items in the response (500 maximum)",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 25,
          "example": 25
        }
      },
      "account": {
        "name": "account",
        "in": "path",
        "description": "Account identifier (ID)",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "my-account"
      }
    },
    "schemas": {
      "IndexMeta": {
        "type": "object",
        "description": "Represents meta data for listing endpoints",
        "properties": {
          "total_count": {
            "type": "integer",
            "description": "Total count of returned objects",
            "example": 1
          },
          "offset": {
            "type": "integer",
            "description": "Offset set by the params",
            "example": 0
          },
          "limit": {
            "type": "integer",
            "description": "Limit of the returned list set by the params",
            "example": 25
          }
        }
      },
      "Error": {
        "type": "object",
        "description": "Represents an error object returned in a failed request",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "A unique error code identifying the type of error. See https://developer.b2brouter.net/docs/error_codes for the full code list.",
                "example": "parameter_empty"
              },
              "message": {
                "type": "string",
                "description": "A human-readable error message providing more context about the error.",
                "example": "The parameter 'param' is missing or the value is empty"
              },
              "param": {
                "type": "string",
                "description": "The parameter in the request that caused the error (if applicable).",
                "example": "param"
              },
              "type": {
                "type": "string",
                "description": "The type of error. Currently the only possible value is \"invalid_request_error\".",
                "example": "invalid_request"
              }
            }
          }
        }
      },
      "UnauthorizedError": {
        "type": "object",
        "description": "Represents an error object returned in a failed request",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "A unique error code identifying the type of error.",
                "example": "unauthorized",
                "default": "unauthorized"
              },
              "message": {
                "type": "string",
                "description": "A human-readable error message providing more context about the error.",
                "example": "Invalid API Key provided, or the API key might not have the necessary permissions for this action."
              },
              "type": {
                "type": "string",
                "description": "The type of error, often mirrors the error code for clarity.",
                "example": "invalid_request_error",
                "default": "invalid_request_error"
              }
            }
          }
        }
      },
      "ForbiddenError": {
        "type": "object",
        "description": "Represents an error object returned when the target project is archived",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "description": "A unique error code identifying the type of error.",
                "example": "403",
                "default": "403"
              },
              "message": {
                "type": "string",
                "description": "A human-readable error message providing more context about the error.",
                "example": "The project you are trying to access has been archived."
              },
              "type": {
                "type": "string",
                "description": "The type of error, often mirrors the error code for clarity.",
                "example": "invalid_request_error",
                "default": "invalid_request_error"
              }
            }
          }
        }
      },
      "TransportB2brouter": {
        "type": "object",
        "description": "Represents a configuration for transport B2Brouter",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "",
              "b2brouter"
            ]
          },
          "enabled": {
            "description": "Enable or disable the transport configuration.",
            "type": "boolean",
            "example": true,
            "default": true
          },
          "reception": {
            "type": "boolean",
            "default": false,
            "example": true
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          }
        }
      },
      "TransportEmail": {
        "type": "object",
        "description": "Represents a configuration for transport Email",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "",
              "email"
            ]
          },
          "enabled": {
            "description": "Enable or disable the transport configuration.",
            "type": "boolean",
            "example": true,
            "default": true
          },
          "reception": {
            "type": "boolean",
            "example": true,
            "default": false
          },
          "email_for_reception": {
            "type": "string",
            "example": "tin@b2brouter.email",
            "readOnly": true
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          }
        }
      },
      "TransportPeppol": {
        "type": "object",
        "description": "Represents a configuration for Peppol transport",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "",
              "peppol"
            ]
          },
          "enabled": {
            "description": "Enable or disable the transport configuration.",
            "type": "boolean",
            "example": true,
            "default": true
          },
          "reception": {
            "type": "boolean",
            "default": false,
            "example": true,
            "description": "Enables receiving documents through this transport channel. For Peppol transports, when reception is enabled (along with enabled=true), we publish your participant ID to the SML/SMP (Service Metadata Locator/Service Metadata Publisher) and the Peppol directory, allowing you to receive documents through the Peppol network.\n\nThe system automatically publishes country-specific Peppol document types based on your enabled document type settings (invoice, credit_note, self_billing, order, application_response).\n"
          },
          "invoice": {
            "description": "Enables support for Invoice documents in Peppol SMP. Only available for Peppol transport type.\n**Country-specific formats**: The actual document formats published depend on the Account's country.\n",
            "type": "boolean",
            "default": true,
            "example": true
          },
          "credit_note": {
            "description": "Enables support for CreditNote documents in Peppol SMP. Only available for Peppol transport type.\n**Country-specific formats**: The actual document formats published depend on the Account's country.\n",
            "type": "boolean",
            "default": true,
            "example": true
          },
          "self_billing": {
            "description": "Enables support for Self-Billing Invoice and Self-Billing CreditNote documents in Peppol SMP. Only available for Peppol transport type.\n",
            "type": "boolean",
            "default": false,
            "example": false
          },
          "order": {
            "description": "Enables support for Order documents in Peppol SMP. Only available for Peppol transport type.\nUses UBL Order format regardless of country.\n",
            "type": "boolean",
            "default": true,
            "example": true
          },
          "application_response": {
            "description": "Enables support for ApplicationResponse documents in Peppol SMP. Only available for Peppol transport type.\nUses UBL Application Response v3 formats regardless of country.\n",
            "type": "boolean",
            "default": true,
            "example": true
          },
          "cdar": {
            "description": "Enables support for Cross-Domain Acknowledgement and Response documents in Peppol SMP. Only available for Peppol transport type.\nRelevant for France, where it advertises the capability to receive DGFiP e-reporting acknowledgements.\n",
            "type": "boolean",
            "default": false,
            "example": true
          },
          "pin_scheme": {
            "description": "pin_scheme",
            "type": "string",
            "example": "9930"
          },
          "pin_value": {
            "description": "pin_value",
            "type": "string",
            "example": "DE123456789"
          },
          "sml_status": {
            "type": "string",
            "enum": [
              "not_published",
              "processing",
              "published"
            ],
            "readOnly": true,
            "description": "SML (Service Metadata Locator) registration status. Indicates whether B2Brouter has registered this participant identifier in the Peppol SML. \nOnly reflects the publication state managed by B2Brouter — not the status at third-party SMP providers.\n",
            "example": "published"
          },
          "peppol_directory_status": {
            "type": "string",
            "enum": [
              "not_published",
              "processing",
              "published"
            ],
            "readOnly": true,
            "description": "Peppol Directory publication status. Indicates whether B2Brouter has registered this participant in the Peppol Directory for discovery by other participants. \nOnly reflects the publication state managed by B2Brouter.\n",
            "example": "published"
          },
          "reception_document_types": {
            "type": "array",
            "readOnly": true,
            "description": "List of Peppol document types this transport can receive, based on country\nand enabled document type capabilities (invoice, credit_note, etc.).\nEmpty when reception is disabled.\n",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Internal document type code. Matches codes from the /document_types endpoint.",
                  "example": "xml.ubl.invoice.bis3"
                },
                "name": {
                  "type": "string",
                  "description": "Human-readable name of the document type.",
                  "example": "Peppol BIS3 Invoice"
                }
              }
            }
          },
          "migration_code": {
            "type": "string",
            "writeOnly": true,
            "example": "Xk9$mQ2!vTz4",
            "description": "Migration code issued by the provider that currently publishes this identifier, to move it to B2Brouter in the same request that enables reception.\n\nSend it only when enabling reception on an identifier that another provider publishes — the case that otherwise fails with a `409`. In any other request the code is refused with a `422`, never ignored; in the sandbox it is refused with a `409`, since migration codes are unavailable there. It is write-only: it never appears in a response.\n"
          },
          "migration_pending": {
            "type": "boolean",
            "readOnly": true,
            "example": false,
            "description": "`true` while a migration code issued for this account has not been cancelled. It only reflects the state of the code at B2Brouter, not where the identifier is published: B2Brouter is not notified when the gaining provider completes the migration, so the flag stays `true` then and only turns back to `false` when the code is cancelled. The code itself is never returned here.\n"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          }
        }
      },
      "TransportUserPassword": {
        "type": "object",
        "description": "Represents a configuration for transport UserPassword",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "",
              "es.pecam",
              "es.eusko_jaurlaritza"
            ],
            "example": "es.pecam"
          },
          "enabled": {
            "description": "Enable or disable the transport configuration.",
            "type": "boolean",
            "example": true,
            "default": true
          },
          "username": {
            "description": "Username",
            "type": "string",
            "example": "user1234"
          },
          "password": {
            "description": "Password",
            "type": "string",
            "example": "1234pass"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          }
        }
      },
      "TransportEdi": {
        "type": "object",
        "description": "Represents a configuration for transport EDI",
        "properties": {
          "code": {
            "type": "string",
            "enum": [
              "",
              "ediversa",
              "edicom"
            ]
          },
          "enabled": {
            "description": "Enable or disable the transport configuration.",
            "type": "boolean",
            "example": true,
            "default": true
          },
          "username": {
            "description": "Username",
            "type": "string",
            "example": "user1234"
          },
          "password": {
            "description": "Password",
            "type": "string",
            "example": "1234pass"
          },
          "edi_identifier": {
            "description": "PO EDI legal",
            "type": "string",
            "example": "1234edi"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2024-07-07T11:51:57Z",
            "readOnly": true
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ForbiddenError"
            }
          }
        }
      }
    }
  }
}
```