Organizations

Organizations are the top-level structure in Seqera Platform, containing workspaces, members, and teams. Organization owners can add or remove members from an organization or workspace, and can allocate specific access roles within workspaces.

Path and query parameters

Name	Type	Location	Req/Opt	Description
role	string	query	Optional	Filter results by organization role. Accepts: owner, member.
name	string	query	Optional	The organization name to validate for availability and format compliance.
orgId	integer	path	Required	Organization numeric identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 50.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
search	string	query	Optional	Free-text search filter to match against user names and email addresses.
memberId	integer	path	Required	Member numeric identifier.
include	array	query	Optional	Optional array of specific quota names to include in the response. Omit to retrieve all quotas.

Request body parameters

Name	Type	Req/Opt	Description
CreateOrganization			Create organization
organization	object	Optional
organization.id	integer	Optional	Organization numeric identifier.
organization.name	string	Required	Unique organization name. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters.
organization.fullName	string	Required	Full display name for the organization. Maximum 100 characters.
organization.description	string	Optional	Optional description of the organization. Maximum 1000 characters.
organization.location	string	Optional	Optional location or address for the organization. Maximum 100 characters.
organization.website	string	Optional	Optional website URL for the organization.
organization.dateCreated	string	Optional	Timestamp when the organization was created.
organization.lastUpdated	string	Optional	Timestamp when the organization was last updated.
logoId	string	Optional	Logo image identifier for the organization. See Create avatar to upload images and obtain a logo ID.
UpdateOrganization			Update organization
fullName	string	Optional
name	string	Optional
description	string	Optional
location	string	Optional
website	string	Optional
logoId	string	Optional	Updated logo image identifier for the organization. See Create avatar to upload images and obtain a logo ID.
paying	boolean	Optional
type	object	Optional
CreateOrganizationMember			Create organization member
user	string	Optional	Username or email address of the user to add as an organization member.
UpdateOrganizationMemberRole			Update organization member role
role	string	Optional