Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
workspace

Search User Groups

Searches for user groups in the workspace. Multiple or no groups may be returned.

get/v1/workspace/groups/search

Query parameters

namestring required

Name of the target group.

Name of the target group.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

namestring required

The name of the workspace group.

idstring required

The ID of the workspace group.

members_emailsstring[] required

The emails of the members of the workspace group.

Example response

[
  {
    "id": "1234567890",
    "members_emails": [
      "john.doe@example.com",
      "jane.smith@example.com"
    ],
    "name": "My Workspace Group"
  }
]