ELelevenlabs
workspace

Search User Groups

Changed on

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

get/v1/workspace/groups/search

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/workspace/groups/search
  • Auth
    none declared

Query parameters

namestring required

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.

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"
  }
]

Changes

  • 5b595807512cRevision changes
    • info

      api operation id Search_user_groups_v1_workspace_groups_search_get removed and replaced with search_groups

    • info

      the header request parameter xi-api-key became optional

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type

  • 503db4198a44Revision changes
    • info

      endpoint added