---
url: /apidocs/network.md
---
## Network API

| Endpoint | Method | Description |
|-----|-----|-----|
| [network:list](#get-networks) | websocket | Get networks |
| [network:listOrdered](#get-networks-ordered) | websocket | Get networks ordered |
| [network:searchNetworks](#search-networks) | websocket | Search networks |
| [network:searchTexhibitionNetworks](#search-texhibition-networks) | websocket | Search texhibition networks |
| [network:getNetworkInfoForUser](#get-network-info-for-user) | websocket | Get network info for user |
| [network:subscribe](#subscribe-to-network) | websocket | Subscribe to network |
| [network:switch](#switch-network) | websocket | Switch network |
| [network:searchUserNetworks](#search-user-networks) | websocket | Search user networks |
| [network:getNetworksForCountries](#get-networks-for-countries) | websocket | Get networks for countries |
| [network:subscriptionCreated](#network-subscription-created-event) | websocketEvent | Network subscription created event |
| [network:subscriptionUpdated](#network-subscription-updated-event) | websocketEvent | Network subscription updated event |
| [network:subscriptionRemoved](#network-subscription-removed-event) | websocketEvent | Network subscription removed event |

### Get networks

**Method:** websocket

**Endpoint:** network:list

**Description:** API returns list of networks that are available to user.

**Request:**

**Response:**

### Get networks ordered

**Method:** websocket

**Endpoint:** network:listOrdered

**Description:** Function returns networks in next order:

1. default network

2. current user network

3. subscribed networks

4. non subscribed networks

**Request:**

**Response:**

### Search networks

**Method:** websocket

**Endpoint:** network:searchNetworks

**Description:** API returns list of networks (according to search query) that are available to user.

**Request:**

**Response:**

### Search texhibition networks

**Method:** websocket

**Endpoint:** network:searchTexhibitionNetworks

**Description:** API returns list of texhibition networks (hasExpo == true) that are available to user.

**Request:**

**Response:**

### Get network info for user

**Method:** websocket

**Endpoint:** network:getNetworkInfoForUser

**Description:** API returns network info for user.

**Request:**

**Response:**

### Subscribe to network

**Method:** websocket

**Endpoint:** network:subscribe

**Description:** API subscribes user to the network.

**Request:**

**Response:**

### Switch network

**Method:** websocket

**Endpoint:** network:switch

**Description:** API switches user context to another network. All following requests will be handled in context of new network.

If `requestNewSessionId` parameter provided - client will receive new session. Old session id could be used to operate in another browser tab in old network.

**Request:**

**Response:**

### Search user networks

**Method:** websocket

**Endpoint:** network:searchUserNetworks

**Description:** API searches networks user is subscribed to.

**Request:**

**Response:**

### Get networks for countries

**Method:** websocket

**Endpoint:** network:getNetworksForCountries

**Description:** API returns list of networks with non-empty `settings.general.countryId`. (Humanity API)

**Request:**

**Response:**

### Network subscription created event

**Event:** network:subscriptionCreated

**Data:**

### Network subscription updated event

**Event:** network:subscriptionUpdated

**Data:**

### Network subscription removed event

**Event:** network:subscriptionRemoved

**Data:**

## Models

#### Network