# List Memberships

GET /api/v1/memberships/

List direct memberships (GroupMembers) for the current workspace context. Includes member user info, roles, and profile metadata. Supports filtering by search (username/email) and roles.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/memberships/list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/memberships/:
    get:
      operationId: list
      summary: List Memberships
      description: >-
        List direct memberships (GroupMembers) for the current workspace
        context. Includes member user info, roles, and profile metadata.
        Supports filtering by search (username/email) and roles.
      tags:
        - subpackage_memberships
      parameters:
        - name: page
          in: query
          description: A page number within the paginated result set.
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          description: Number of results to return per page.
          required: false
          schema:
            type: integer
        - name: q
          in: query
          description: Case-insensitive substring search across username OR email.
          required: false
          schema:
            type: string
        - name: roles
          in: query
          description: >-
            Filter by one or more role codenames (OR logic). Use comma-separated
            list (e.g. EDITOR,ADMIN) or repeat the parameter
            (roles=EDITOR&roles=OWNER).
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Membership list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMembershipList'
components:
  schemas:
    Membership:
      type: object
      properties:
        id:
          type: integer
        member:
          type: integer
        group:
          type: integer
        role:
          type: string
          default: VIEWER
        roles_list:
          type: array
          items:
            type: string
        email:
          type: string
          format: email
        user_email:
          type: string
        user_username:
          type: string
        user_fullname:
          type: string
        workspace_name:
          type: string
        profile_picture:
          type: string
        recent_activity:
          type: string
        joined_at:
          type: string
          format: date-time
        status:
          type: string
        current_role:
          type: string
      required:
        - id
        - member
        - group
        - roles_list
        - user_email
        - user_username
        - user_fullname
        - workspace_name
        - profile_picture
        - recent_activity
        - joined_at
        - status
        - current_role
      description: Serializer for DGM GroupMember (Membership) model.
      title: Membership
    PaginatedMembershipList:
      type: object
      properties:
        count:
          type: integer
        next:
          type:
            - string
            - 'null'
          format: uri
        previous:
          type:
            - string
            - 'null'
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/Membership'
      required:
        - count
        - results
      title: PaginatedMembershipList

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/memberships/"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/memberships/';
const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/memberships/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/memberships/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/memberships/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/api/v1/memberships/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/memberships/");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/memberships/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```