Organization Collectives

List collectives of an organization

get

https://api.example.comhttps://staging-api.example.com

/memberships/orgs/{organisationId}/collectives

Gets the list of all collectives that belong to the specified organization

Path parameters

organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20Example: 20

Responses

200

List of collectives retrieved successfully

application/json

500

Internal server error

application/json

get

/memberships/orgs/{organisationId}/collectives

HTTPcURLJavaScriptPython

GET /memberships/orgs/{organisationId}/collectives HTTP/1.1
Host: api.example.com
Accept: */*

{
  "data": [
    {
      "id": "collective123-def6-7890-abcd-ef1234567890",
      "name": "Kira Collective",
      "description": "Logistics and delivery collective",
      "organisationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z",
      "memberCount": 25,
      "teamCount": 3,
      "status": "active",
      "metadata": {
        "region": "LATAM",
        "industry": "Logistics",
        "budget": 25000
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

Create a new collective

post

https://api.example.comhttps://staging-api.example.com

/memberships/orgs/{organisationId}/collectives

Creates a new collective within the specified organization

Path parameters

organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

Body

application/json

namestring · max: 100Required

Name of the collective

Example: Kira Collective

descriptionstring · max: 500Optional

Description of the collective

Example: Logistics and delivery collective

statusstring · enumOptional

Status of the collective

Default: activeExample: activePossible values:

Responses

201

Collective created successfully

application/json

500

Internal server error

application/json

post

/memberships/orgs/{organisationId}/collectives

HTTPcURLJavaScriptPython

POST /memberships/orgs/{organisationId}/collectives HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "name": "Kira Collective",
  "description": "Logistics and delivery collective",
  "status": "active",
  "metadata": {
    "region": "LATAM",
    "industry": "Logistics",
    "budget": 25000
  }
}

{
  "id": "collective123-def6-7890-abcd-ef1234567890",
  "name": "Kira Collective",
  "description": "Logistics and delivery collective",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "memberCount": 0,
  "teamCount": 0,
  "status": "active",
  "metadata": {
    "region": "LATAM",
    "industry": "Logistics",
    "budget": 25000
  }
}

Get collective information

get

https://api.example.comhttps://staging-api.example.com

/memberships/orgs/{organisationId}/collectives/{collectiveId}

Gets the information of a specific collective in the organization

Path parameters

organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

collectiveIdstring · uuidRequired

Unique ID of the collective

Example: collective123-def6-7890-abcd-ef1234567890

Responses

200

Collective information retrieved successfully

application/json

idstring · uuidOptional

Unique collective ID

Example: collective123-def6-7890-abcd-ef1234567890

namestringOptional

Name of the collective

Example: Kira Collective

descriptionstringOptional

Description of the collective

Example: Logistics and delivery collective

organisationIdstring · uuidOptional

ID of the parent organization

Example: 123e4567-e89b-12d3-a456-426614174000

memberCountintegerOptional

Number of members in the collective

Example: 25

teamCountintegerOptional

Number of teams in the collective

Example: 3

statusstring · enumOptional

Current status of the collective

Example: activePossible values:

createdAtstring · date-timeOptional

Date and time when the collective was created

Example: 2024-01-15T10:30:00Z

updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z

500

Internal server error

application/json

get

/memberships/orgs/{organisationId}/collectives/{collectiveId}

HTTPcURLJavaScriptPython

GET /memberships/orgs/{organisationId}/collectives/{collectiveId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "id": "collective123-def6-7890-abcd-ef1234567890",
  "name": "Kira Collective",
  "description": "Logistics and delivery collective",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "memberCount": 25,
  "teamCount": 3,
  "status": "active",
  "metadata": {
    "region": "LATAM",
    "industry": "Logistics",
    "budget": 25000
  }
}

Update collective information

put

https://api.example.comhttps://staging-api.example.com

/memberships/orgs/{organisationId}/collectives/{collectiveId}

Updates the information of a specific collective in the organization

Path parameters

organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

collectiveIdstring · uuidRequired

Unique ID of the collective

Example: collective123-def6-7890-abcd-ef1234567890

Body

application/json

namestring · max: 100Optional

New name for the collective

Example: Kira Logistics Collective

descriptionstring · max: 500Optional

New description for the collective

Example: Enhanced logistics and delivery collective with expanded services

statusstring · enumOptional

New status for the collective

Example: activePossible values:

Responses

200

Collective updated successfully

application/json

idstring · uuidOptional

Unique collective ID

Example: collective123-def6-7890-abcd-ef1234567890

namestringOptional

Name of the collective

Example: Kira Collective

descriptionstringOptional

Description of the collective

Example: Logistics and delivery collective

organisationIdstring · uuidOptional

ID of the parent organization

Example: 123e4567-e89b-12d3-a456-426614174000

memberCountintegerOptional

Number of members in the collective

Example: 25

teamCountintegerOptional

Number of teams in the collective

Example: 3

statusstring · enumOptional

Current status of the collective

Example: activePossible values:

createdAtstring · date-timeOptional

Date and time when the collective was created

Example: 2024-01-15T10:30:00Z

updatedAtstring · date-timeOptional

Date and time of last update

Example: 2024-01-20T14:45:00Z

500

Internal server error

application/json

put

/memberships/orgs/{organisationId}/collectives/{collectiveId}

HTTPcURLJavaScriptPython

PUT /memberships/orgs/{organisationId}/collectives/{collectiveId} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "Kira Logistics Collective",
  "description": "Enhanced logistics and delivery collective with expanded services",
  "status": "active",
  "metadata": {
    "region": "LATAM",
    "industry": "Logistics",
    "budget": 35000,
    "expansion": "Q2-2024"
  }
}

{
  "id": "collective123-def6-7890-abcd-ef1234567890",
  "name": "Kira Logistics Collective",
  "description": "Enhanced logistics and delivery collective with expanded services",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-22T16:30:00Z",
  "memberCount": 25,
  "teamCount": 3,
  "status": "active",
  "metadata": {
    "region": "LATAM",
    "industry": "Logistics",
    "budget": 35000,
    "expansion": "Q2-2024"
  }
}

Delete a collective

delete

https://api.example.comhttps://staging-api.example.com

/memberships/orgs/{organisationId}/collectives/{collectiveId}

Deletes a specific collective from the organization

Path parameters

organisationIdstring · uuidRequired

Unique ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

collectiveIdstring · uuidRequired

Unique ID of the collective to delete

Example: collective123-def6-7890-abcd-ef1234567890

Responses

200

Collective deleted successfully

application/json

successbooleanRequired

Indicates if the operation was successful

Example: true

messagestringRequired

Descriptive success message

Example: Operation completed successfully

500

Internal server error

application/json

delete

/memberships/orgs/{organisationId}/collectives/{collectiveId}

HTTPcURLJavaScriptPython

DELETE /memberships/orgs/{organisationId}/collectives/{collectiveId} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "success": true,
  "message": "Collective successfully deleted"
}