List Subscribers

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers

GET

/api/fabric/resources/subscribers

$ curl https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers \
>      -u "<project_id>:<api_token>"

1 {
2   "data": [
3     {
4       "id": "d369a402-7b43-4512-8735-9d5e1f387814",
5       "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
6       "display_name": "John Doe",
7       "type": "subscriber",
8       "created_at": "2024-05-06T12:20:00Z",
9       "updated_at": "2024-05-06T12:20:00Z",
10       "subscriber": {
11         "id": "d369a402-7b43-4512-8735-9d5e1f387814",
12         "email": "johndoe@example.com",
13         "first_name": "John",
14         "last_name": "Doe",
15         "display_name": "John Doe",
16         "job_title": "Software Engineer",
17         "timezone": "America/New_York",
18         "country": "United States",
19         "company_name": "SignalWire"
20       }
21     }
22   ],
23   "links": {
24     "self": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
25     "first": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
26     "next": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
27     "prev": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
28   }
29 }

Returns the project’s Subscriber resources. Use it to inventory known user identities before retrieving, updating, or issuing access for one. Use Get Subscriber when you already have a resource ID; temporary guests use Guest or Invite Tokens rather than full Subscriber resources.

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.

Returns the project's [Subscriber](/docs/platform/subscribers) resources. Use it to inventory known user identities before retrieving, updating, or issuing access for one. Use [Get Subscriber](/docs/apis/rest/subscribers/get-subscriber) when you already have a resource ID; temporary guests use Guest or Invite Tokens rather than full Subscriber resources. #### 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).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Response

The request has succeeded.

datalist of objects

An array of objects that contain a list of Subscriber data

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error