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": "3ff431fc-e937-4ac2-8189-b68dd6ef33ea",
      "alias": "MMC Client A",
      "externalId": "MOCKED-3ff431fc-e937-4ac2-8189-b68dd6ef33ea",
      "companies": [
        {
          "id": "1583d222-d810-433e-b288-e446dbed97d3",
          "name": "Company Demo 1",
          "legalId": "A08238198",
          "legalName": "MMC Company Demo 1",
          "state": "active",
          "contactEmail": "[email protected]",
          "corporationId": "3ff431fc-e937-4ac2-8189-b68dd6ef33ea",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Una dirección",
            "streetNumber": "1",
            "details": "nada",
            "street": "Una dirección, 1, nada",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicnate",
            "district": null
          },
          "legalAddress": {
            "streetName": "Una dirección",
            "streetNumber": "1",
            "details": "nada",
            "street": "Una dirección, 1, nada",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicnate",
            "district": null
          }
        },
        {
          "id": "00117907-289c-43f3-9e53-9a3b9d393540",
          "name": "Company Demo 2",
          "legalId": "A97005722",
          "legalName": "MMC Company Demo 2",
          "state": "active",
          "contactEmail": "[email protected]",
          "corporationId": "3ff431fc-e937-4ac2-8189-b68dd6ef33ea",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Cualquier carrer",
            "streetNumber": "4",
            "details": "nada",
            "street": "Cualquier carrer, 4, nada",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicante",
            "district": null
          },
          "legalAddress": {
            "streetName": "Cualquier carrer",
            "streetNumber": "4",
            "details": "nada",
            "street": "Cualquier carrer, 4, nada",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicante",
            "district": null
          }
        }
      ]
    },
    {
      "id": "a5ce757d-8fbd-4231-a4ad-b893aa61c01b",
      "alias": "MMC Client B",
      "externalId": "MOCKED-a5ce757d-8fbd-4231-a4ad-b893aa61c01b",
      "companies": [
        {
          "id": "6753738e-7c0d-42d3-984e-75abc24f62c5",
          "name": "Company Demo 3",
          "legalId": "A84902246",
          "legalName": "MMC Company Demo 3",
          "state": "active",
          "contactEmail": "[email protected]",
          "corporationId": "a5ce757d-8fbd-4231-a4ad-b893aa61c01b",
          "countryISO2Code": "ES",
          "deliveryAddress": {
            "streetName": "Calle cualquiera",
            "streetNumber": "598",
            "details": "ninguno",
            "street": "Calle cualquiera, 598, ninguno",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicante",
            "district": null
          },
          "legalAddress": {
            "streetName": "Calle cualquiera",
            "streetNumber": "598",
            "details": "ninguno",
            "street": "Calle cualquiera, 598, ninguno",
            "postalCode": "03540",
            "province": "Alicante",
            "locality": "Alicante",
            "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