Organization Collectives

List collectives of an organization

get
/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
chevron-right
200

List of collectives retrieved successfully

application/json
get
/memberships/orgs/{organisationId}/collectives

Create a new collective

post
/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
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
post
/memberships/orgs/{organisationId}/collectives

Get collective information

get
/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
chevron-right
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
get
/memberships/orgs/{organisationId}/collectives/{collectiveId}

Update collective information

put
/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
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
chevron-right
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
put
/memberships/orgs/{organisationId}/collectives/{collectiveId}

Delete a collective

delete
/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
chevron-right
200

Collective deleted successfully

application/json
successbooleanRequired

Indicates if the operation was successful

Example: true
messagestringRequired

Descriptive success message

Example: Operation completed successfully
delete
/memberships/orgs/{organisationId}/collectives/{collectiveId}

Last updated