> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# list

> List subscriber resources.

List [subscriber](/docs/platform/subscribers) resources in the project.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources/subscribers:
    get:
      operationId: list_subscribers
      summary: List Subscribers
      description: >-
        Retrieve a list of all [subscribers](/docs/platform/subscribers).


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or
        _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_subscribers
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    SubscriberResponseType:
      type: string
      enum:
        - subscriber
      description: Type of the resource.
      title: SubscriberResponseType
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    Subscriber:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Subscriber.
        email:
          type: string
          description: Email of the Subscriber.
        first_name:
          type: string
          description: First name of the Subscriber.
        last_name:
          type: string
          description: Last name of the Subscriber.
        display_name:
          type: string
          description: Display name of the Subscriber.
        job_title:
          type: string
          description: Job title of the Subscriber.
        timezone:
          type: string
          description: Timezone of the Subscriber.
        country:
          type: string
          description: Country of the Subscriber.
        company_name:
          type: string
          description: Company name of the Subscriber.
      required:
        - id
        - email
        - first_name
        - last_name
        - display_name
        - job_title
        - timezone
        - country
        - company_name
      title: Subscriber
    SubscriberResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the request.
        project_id:
          type: string
          description: Unique ID of the project.
        display_name:
          type: string
          description: Display name of the Subscriber.
        type:
          $ref: '#/components/schemas/SubscriberResponseType'
          description: Type of the resource.
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        subscriber:
          $ref: '#/components/schemas/Subscriber'
          description: Subscriber data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - subscriber
      title: SubscriberResponse
    SubscriberPaginationResponse:
      type: object
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page
        first:
          type: string
          format: uri
          description: Link to the first page
        next:
          type: string
          format: uri
          description: Link to the next page
        prev:
          type: string
          format: uri
          description: Link to the previous page
      required:
        - self
        - first
      title: SubscriberPaginationResponse
    SubscriberListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriberResponse'
          description: An array of objects that contain a list of Subscriber data
        links:
          $ref: '#/components/schemas/SubscriberPaginationResponse'
          description: Object containing pagination links
      required:
        - data
        - links
      title: SubscriberListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "data": [
    {
      "id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
      "display_name": "John Doe",
      "type": "subscriber",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "subscriber": {
        "id": "d369a402-7b43-4512-8735-9d5e1f387814",
        "email": "johndoe@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "display_name": "John Doe",
        "job_title": "Software Engineer",
        "timezone": "America/New_York",
        "country": "United States",
        "company_name": "SignalWire"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

const response = await client.fabric.subscribers.list();
for (const subscriber of response.data ?? []) {
  console.log(`${subscriber.display_name}: ${subscriber.id}`);
}
```