Skip to main content
GET
/
v1
/
collectives
/
{collectiveId}
Retrieve a Collective
curl --request GET \
  --url https://api.traxes.io/connect/v1/collectives/{collectiveId} \
  --header 'Authorization: Bearer <token>'
{
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<any>",
  "type": "Household"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
collectiveId
string<uuid>
required

The id of the Collective

Response

OK

A Collective

​
entities
string<uuid>[] | null

The Entities of the Collective

​
id
string<uuid>

The id of the Collective

​
name
string | null

The name of the Collective

​
owner
string<uuid>

The owner of the Collective

​
properties
any

The custom properties of the Collective

​
type
enum<string>

Types of a Collective.

Available options:
Household,
Fleet,
SolarFarm,
VirtualPowerPlant