Skip to main content
GET
/
corporations
Get all corporations associated with the authenticated user
curl --request GET \
  --url https://pre-partners-api.cobee.io/api/v3/corporations \
  --header 'Authorization: Bearer <token>'
{
  "corporations": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "alias": "Iberian Foods Group",
      "externalId": "EXT-0001",
      "companies": [
        {
          "id": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6789012",
          "name": "Iberian Foods Madrid",
          "legalId": "B12345678",
          "legalName": "Iberian Foods Madrid S.A.",
          "state": "active",
          "contactEmail": "john.smith@example.com",
          "corporationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Calle Gran Vía",
            "streetNumber": "10",
            "details": "Planta 2",
            "street": "Calle Gran Vía, 10, Planta 2",
            "postalCode": "28013",
            "province": "Madrid",
            "locality": "Madrid",
            "district": null
          },
          "legalAddress": {
            "streetName": "Calle Gran Vía",
            "streetNumber": "10",
            "details": "Planta 2",
            "street": "Calle Gran Vía, 10, Planta 2",
            "postalCode": "28013",
            "province": "Madrid",
            "locality": "Madrid",
            "district": null
          }
        },
        {
          "id": "c3d4e5f6-a7b8-9012-c3d4-e5f678901234",
          "name": "Iberian Foods Barcelona",
          "legalId": "B87654321",
          "legalName": "Iberian Foods Barcelona S.L.",
          "state": "active",
          "contactEmail": "jane.doe@example.com",
          "corporationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Passeig de Gràcia",
            "streetNumber": "42",
            "details": null,
            "street": "Passeig de Gràcia, 42",
            "postalCode": "08007",
            "province": "Barcelona",
            "locality": "Barcelona",
            "district": null
          },
          "legalAddress": {
            "streetName": "Passeig de Gràcia",
            "streetNumber": "42",
            "details": null,
            "street": "Passeig de Gràcia, 42",
            "postalCode": "08007",
            "province": "Barcelona",
            "locality": "Barcelona",
            "district": null
          }
        }
      ]
    },
    {
      "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "alias": "Northern Logistics",
      "externalId": "EXT-0002",
      "companies": [
        {
          "id": "d4e5f678-90ab-cdef-0123-456789abcdef",
          "name": "Northern Logistics Sevilla",
          "legalId": "A08000143",
          "legalName": "Northern Logistics Sevilla S.A.U.",
          "state": "active",
          "contactEmail": "contact@example.com",
          "corporationId": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Avenida de la Constitución",
            "streetNumber": "100",
            "details": "Edificio B",
            "street": "Avenida de la Constitución, 100, Edificio B",
            "postalCode": "41001",
            "province": "Sevilla",
            "locality": "Sevilla",
            "district": null
          },
          "legalAddress": {
            "streetName": "Avenida de la Constitución",
            "streetNumber": "100",
            "details": "Edificio B",
            "street": "Avenida de la Constitución, 100, Edificio B",
            "postalCode": "41001",
            "province": "Sevilla",
            "locality": "Sevilla",
            "district": null
          }
        }
      ]
    }
  ],
  "page": {
    "size": 25,
    "totalElements": 2,
    "totalPages": 1,
    "number": 1
  }
}

Overview

Retrieve a list of the corporations associated with the authenticated user. A corporation is a group of related companies.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

externalId

Corporation External ID to filter by. Can be a single ID or multiple IDs separated by commas

include
boolean

Whether to include companies for each corporation in the response. If true, companies are included; if false, companies are omitted.

page
integer
default:1

Page number to retrieve. Defaults to 1.

Required range: x >= 1
limit
integer
default:25

Max number of items per page. Must be greater than 0. Defaults to 25. Maximum is 25.

Required range: 1 <= x <= 25

Response

Corporations successfully retrieved

corporations
object[]
page
object