# List members

GET //localhost:8080/api/v1/members

List members with usage from v_member_usage. Owner, admin, viewer. Member role cannot list. When Collector analytics is configured, spend and requests on each row and overview totals are merged from GET /v1/analytics/members/cost-breakdown (default Collector window, no date query params) by member id.

Reference: https://api.alephant.io/api-reference/saa-s-api/members/list-members

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/members:
    get:
      operationId: list-members
      summary: List members
      description: >-
        List members with usage from v_member_usage. Owner, admin, viewer.
        Member role cannot list. When Collector analytics is configured, spend
        and requests on each row and overview totals are merged from GET
        /v1/analytics/members/cost-breakdown (default Collector window, no date
        query params) by member id.
      tags:
        - subpackage_members
      parameters:
        - name: page
          in: query
          description: Page number
          required: false
          schema:
            type: integer
            default: 1
        - name: pageSize
          in: query
          description: Items per page
          required: false
          schema:
            type: integer
            default: 20
        - name: status
          in: query
          description: active, revoked, suspended
          required: false
          schema:
            type: string
        - name: departmentId
          in: query
          description: Department UUID
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: Search name/email
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer {access_token}
          required: true
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: Workspace UUID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal_api_handlers_members.ListMembersResponse
        '400':
          description: X-Workspace-Id required
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '401':
          description: AUTH_TOKEN_EXPIRED
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '403':
          description: TIER_FEATURE_DISABLED or FORBIDDEN
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
servers:
  - url: //localhost:8080
components:
  schemas:
    internal_api_handlers_members.MemberListItem:
      type: object
      properties:
        createdAt:
          type: string
        departmentId:
          type: string
        email:
          type: string
        id:
          type: string
        keyExpiresAt:
          type: string
        keyExpiryPreset:
          type: string
        masterKeyId:
          type: string
        monthlyBudget:
          type: number
          format: double
        name:
          type: string
        note:
          type: string
        requests:
          type: integer
        roleLabel:
          type: string
        spend:
          type: number
          format: double
        status:
          type: string
        tokens:
          type: integer
          description: >-
            Tokens is period token usage when Collector cost-breakdown
            enrichment applies; otherwise 0.
        virtualKey:
          type: string
        virtualKeyId:
          type: string
        virtualKeyStatus:
          type: string
      title: internal_api_handlers_members.MemberListItem
    internal_api_handlers_members.MemberListOverview:
      type: object
      properties:
        activeCount:
          type: integer
        totalMonthlyBudgetCents:
          type: integer
        totalPeriodRequests:
          type: integer
        totalPeriodSpendCents:
          type: integer
        totalPeriodSpendUsd:
          type: number
          format: double
        totalPeriodTokens:
          type: integer
        withVirtualKeyCount:
          type: integer
      title: internal_api_handlers_members.MemberListOverview
    internal_api_handlers_members.Meta:
      type: object
      properties:
        overview:
          $ref: >-
            #/components/schemas/internal_api_handlers_members.MemberListOverview
          description: >-
            Overview is workspace-wide aggregates from v_member_usage (not
            limited to the current page).
        page:
          type: integer
        pageSize:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
      title: internal_api_handlers_members.Meta
    internal_api_handlers_members.ListMembersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/internal_api_handlers_members.MemberListItem'
        meta:
          $ref: '#/components/schemas/internal_api_handlers_members.Meta'
      title: internal_api_handlers_members.ListMembersResponse

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/members"

headers = {
    "Authorization": "Authorization",
    "X-Workspace-Id": "X-Workspace-Id"
}

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

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/members';
const options = {
  method: 'GET',
  headers: {Authorization: 'Authorization', 'X-Workspace-Id': 'X-Workspace-Id'}
};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:8080/api/v1/members"

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

	req.Header.Add("Authorization", "Authorization")
	req.Header.Add("X-Workspace-Id", "X-Workspace-Id")

	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://localhost:8080/api/v1/members")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Authorization'
request["X-Workspace-Id"] = 'X-Workspace-Id'

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://localhost:8080/api/v1/members")
  .header("Authorization", "Authorization")
  .header("X-Workspace-Id", "X-Workspace-Id")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://localhost:8080/api/v1/members', [
  'headers' => [
    'Authorization' => 'Authorization',
    'X-Workspace-Id' => 'X-Workspace-Id',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/members");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Authorization");
request.AddHeader("X-Workspace-Id", "X-Workspace-Id");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Authorization",
  "X-Workspace-Id": "X-Workspace-Id"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/members")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```