A Group is a collection of Organization Memberships within an Organization. Use Groups to organize users into organizational units.
To list the groups that a specific Organization Membership belongs to, use List Groups.
{ "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
groupGet a paginated list of groups within an organization.
curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups" \ --header "Authorization: Bearer sk_example_123456789"
{ "object": "list", "data": [ { "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" } ], "list_metadata": { "before": "group_01HXYZ123456789ABCDEFGHIJ", "after": "group_01HXYZ987654321KJIHGFEDCBA" } }
| curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.list_organization_groups(organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.list_organization_groups(organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().ListOrganizationGroups(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->listOrganizationGroups(organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.listOrganizationGroups("org_01EHWNCE74X7JSDV0X3SZ3KJNY"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.ListOrganizationGroupsAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .list_organization_groups("org_01EHWNCE74X7JSDV0X3SZ3KJNY") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "list", | |
| "data": [ | |
| { | |
| "object": "group", | |
| "id": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "name": "Engineering", | |
| "description": "The engineering team", | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } | |
| ], | |
| "list_metadata": { | |
| "before": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "after": "group_01HXYZ987654321KJIHGFEDCBA" | |
| } | |
| } |
GET/organizationsParameters Returns objectCreate a new group within an organization.
curl --request POST \ --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups" \ --header "Authorization: Bearer sk_example_123456789" \ --header "Content-Type: application/json" \ -d @- <<'BODY' { "name": "Engineering", "description": "The engineering team" } BODY
{ "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl --request POST \ | |
| --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "name": "Engineering", | |
| "description": "The engineering team" | |
| } | |
| BODY |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.create_organization_group( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| name: "Engineering" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.create_organization_group( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", name="Engineering" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().CreateOrganizationGroup(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", &workos.GroupsCreateOrganizationGroupParams{ | |
| Name: "Engineering", | |
| }) | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->createOrganizationGroup( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| name: "Engineering", | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.groups.GroupsApi.CreateOrganizationGroupOptions; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| CreateOrganizationGroupOptions options = | |
| CreateOrganizationGroupOptions.builder().name("Engineering").build(); | |
| workos.groups.createOrganizationGroup("org_01EHWNCE74X7JSDV0X3SZ3KJNY", options); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.CreateOrganizationGroupAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| new GroupsCreateOrganizationGroupOptions { | |
| Name = "Engineering", | |
| }); |
| use workos::Client; | |
| use workos::groups::CreateOrganizationGroupParams; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .create_organization_group( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| CreateOrganizationGroupParams { | |
| name: "Engineering".into(), | |
| ..Default::default() | |
| } | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "group", | |
| "id": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "name": "Engineering", | |
| "description": "The engineering team", | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
POST/organizationsParameters Returns Retrieve a group by its ID within an organization.
curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ --header "Authorization: Bearer sk_example_123456789"
{ "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.get_organization_group( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.get_organization_group( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().GetOrganizationGroup(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->getOrganizationGroup( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.getOrganizationGroup( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.GetOrganizationGroupAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .get_organization_group( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "group", | |
| "id": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "name": "Engineering", | |
| "description": "The engineering team", | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
GET/organizationsParameters Returns Update an existing group. Only the fields provided in the request body will be updated.
curl --request PATCH \ --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ --header "Authorization: Bearer sk_example_123456789" \ --header "Content-Type: application/json" \ -d @- <<'BODY' { "name": "Engineering", "description": "The engineering team" } BODY
{ "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl --request PATCH \ | |
| --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "name": "Engineering", | |
| "description": "The engineering team" | |
| } | |
| BODY |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.update_organization_group( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.update_organization_group( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().UpdateOrganizationGroup(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->updateOrganizationGroup( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.updateOrganizationGroup( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.UpdateOrganizationGroupAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .update_organization_group( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "group", | |
| "id": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "name": "Engineering", | |
| "description": "The engineering team", | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
PATCH/organizationsParameters Returns Delete a group from an organization.
curl --request DELETE \ --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ --header "Authorization: Bearer sk_example_123456789"
| curl --request DELETE \ | |
| --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.delete_organization_group( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.delete_organization_group( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().DeleteOrganizationGroup(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->deleteOrganizationGroup( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.deleteOrganizationGroup( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.DeleteOrganizationGroupAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .delete_organization_group( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
DELETE/organizationsParameters Returns Get a list of organization memberships in a group.
curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships" \ --header "Authorization: Bearer sk_example_123456789"
{ "object": "list", "data": [ { "object": "organization_membership", "id": "om_01HXYZ123456789ABCDEFGHIJ", "user_id": "user_01E4ZCR3C56J083X43JQXF3JK5", "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT", "status": "active", "directory_managed": false, "organization_name": "Acme Corp", "custom_attributes": { "department": "Engineering", "title": "Developer Experience Engineer", "location": "Brooklyn" }, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" } ], "list_metadata": { "before": "om_01HXYZ123456789ABCDEFGHIJ", "after": "om_01HXYZ987654321KJIHGFEDCBA" } }
| curl "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.list_group_organization_memberships( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.list_group_organization_memberships( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().ListOrganizationMemberships(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->listGroupOrganizationMemberships( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.listGroupOrganizationMemberships( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.ListOrganizationMembershipsAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .list_group_organization_memberships( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ" | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "list", | |
| "data": [ | |
| { | |
| "object": "organization_membership", | |
| "id": "om_01HXYZ123456789ABCDEFGHIJ", | |
| "user_id": "user_01E4ZCR3C56J083X43JQXF3JK5", | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "status": "active", | |
| "directory_managed": false, | |
| "organization_name": "Acme Corp", | |
| "custom_attributes": { | |
| "department": "Engineering", | |
| "title": "Developer Experience Engineer", | |
| "location": "Brooklyn" | |
| }, | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } | |
| ], | |
| "list_metadata": { | |
| "before": "om_01HXYZ123456789ABCDEFGHIJ", | |
| "after": "om_01HXYZ987654321KJIHGFEDCBA" | |
| } | |
| } |
GET/organizationsParameters Returns objectAdd an organization membership to a group.
curl --request POST \ --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships" \ --header "Authorization: Bearer sk_example_123456789" \ --header "Content-Type: application/json" \ -d @- <<'BODY' { "organization_membership_id": "om_01HXYZ123456789ABCDEFGHIJ" } BODY
{ "object": "group", "id": "group_01HXYZ123456789ABCDEFGHIJ", "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "name": "Engineering", "description": "The engineering team", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl --request POST \ | |
| --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "organization_membership_id": "om_01HXYZ123456789ABCDEFGHIJ" | |
| } | |
| BODY |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.create_group_organization_membership( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ", | |
| organization_membership_id: "om_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.create_group_organization_membership( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| organization_membership_id="om_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().CreateOrganizationMembership(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ", &workos.GroupsCreateOrganizationMembershipParams{ | |
| OrganizationMembershipID: "om_01HXYZ123456789ABCDEFGHIJ", | |
| }) | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->createGroupOrganizationMembership( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| organizationMembershipId: "om_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.groups.GroupsApi.CreateGroupOrganizationMembershipOptions; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| CreateGroupOrganizationMembershipOptions options = | |
| CreateGroupOrganizationMembershipOptions.builder() | |
| .organizationMembershipId("om_01HXYZ123456789ABCDEFGHIJ") | |
| .build(); | |
| workos.groups.createGroupOrganizationMembership( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ", options); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.CreateOrganizationMembershipAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ", | |
| new GroupsCreateOrganizationMembershipOptions { | |
| OrganizationMembershipId = "om_01HXYZ123456789ABCDEFGHIJ", | |
| }); |
| use workos::Client; | |
| use workos::groups::CreateGroupOrganizationMembershipParams; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .create_group_organization_membership( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ", | |
| CreateGroupOrganizationMembershipParams { | |
| organization_membership_id: "om_01HXYZ123456789ABCDEFGHIJ".into(), | |
| ..Default::default() | |
| } | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "object": "group", | |
| "id": "group_01HXYZ123456789ABCDEFGHIJ", | |
| "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "name": "Engineering", | |
| "description": "The engineering team", | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
POST/organizationsParameters Returns Remove an organization membership from a group.
curl --request DELETE \ --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships/om_01HXYZ123456789ABCDEFGHIJ" \ --header "Authorization: Bearer sk_example_123456789"
| curl --request DELETE \ | |
| --url "https://api.workos.com/organizations/org_01EHWNCE74X7JSDV0X3SZ3KJNY/groups/group_01HXYZ123456789ABCDEFGHIJ/organization-memberships/om_01HXYZ123456789ABCDEFGHIJ" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.groups.delete_group_organization_membership( | |
| organization_id: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id: "group_01HXYZ123456789ABCDEFGHIJ", | |
| om_id: "om_01HXYZ123456789ABCDEFGHIJ" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.groups.delete_group_organization_membership( | |
| organization_id="org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| group_id="group_01HXYZ123456789ABCDEFGHIJ", | |
| om_id="om_01HXYZ123456789ABCDEFGHIJ", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Groups().DeleteOrganizationMembership(context.Background(), "org_01EHWNCE74X7JSDV0X3SZ3KJNY", "group_01HXYZ123456789ABCDEFGHIJ", "om_01HXYZ123456789ABCDEFGHIJ") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->groups() | |
| ->deleteGroupOrganizationMembership( | |
| organizationId: "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| groupId: "group_01HXYZ123456789ABCDEFGHIJ", | |
| omId: "om_01HXYZ123456789ABCDEFGHIJ", | |
| ); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.groups.deleteGroupOrganizationMembership("org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ", | |
| "om_01HXYZ123456789ABCDEFGHIJ"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Groups.DeleteOrganizationMembershipAsync("org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ", | |
| "om_01HXYZ123456789ABCDEFGHIJ"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .groups() | |
| .delete_group_organization_membership( | |
| "org_01EHWNCE74X7JSDV0X3SZ3KJNY", | |
| "group_01HXYZ123456789ABCDEFGHIJ", | |
| "om_01HXYZ123456789ABCDEFGHIJ" | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
DELETE/organizationsParameters Returns