list | SignalWire

List RELAY application resources in the project.

Response

datalist of objectsRequired

An array of objects that contain a list of Relay Application data

linksobjectRequired

Object containing pagination links

Response Example

Response

1 {
2   "data": [
3     {
4       "id": "993ed018-9e79-4e50-b97b-984bd5534095",
5       "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
6       "display_name": "Customer Service Bot",
7       "type": "relay_application",
8       "created_at": "2024-05-06T12:20:00Z",
9       "updated_at": "2024-05-06T12:20:00Z",
10       "relay_application": {
11         "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
12         "name": "Booking Assistant",
13         "topic": "booking",
14         "call_status_callback_url": "https://example.com/callbacks"
15       }
16     }
17   ],
18   "links": {
19     "self": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
20     "first": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
21     "next": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application",
22     "prev": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application"
23   }
24 }

Example

1 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 response = client.fabric.relay_applications.list()
10 for item in response.get("data", []):
11     print(f"{item['display_name']}: {item['id']}")