v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB

Viações

Obter todas as viações

Serviço de apoio que retorna a lista completa das viações conectadas à plataforma, permitindo a exibição do nome e logo das operadoras em sua interface. O retorno é paginado e pode ser filtrado por ID.

get/partners/api/v4/bus-companies

Query parameters

idnumber

Opcional: ID da viação

sizenumber

Example:50

Quantidade de itens por página

pagenumber

Example:1

Número da página

Response

Sucesso. Retorno da lista de viações parceiras da ClickBus.

sizenumber required

Quantidade de itens por página

currentPageNumbernumber required

Número da página atual

totalElementsnumber required

Total de elementos

totalPagesnumber required

Total de páginas - calculado por totalElements / size

Example response

{
  "size": 50,
  "currentPageNumber": 1,
  "totalElements": 150,
  "totalPages": 3,
  "content": [
    {
      "id": 1,
      "name": "Empresa de Ônibus",
      "slug": "empresa-de-onibus",
      "logoUrl": "https://www.empresa-de-onibus.com.br/logo.png",
      "createdAt": "2024-04-30 09:19:35",
      "updatedAt": "2024-04-30 09:19:35"
    }
  ]
}