# PushDevicesApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deletePushDevice**](#deletepushdevice) | **DELETE** /push-devices/{pushDeviceId} | Delete a registered push notification device|
|[**getPushDevice**](#getpushdevice) | **GET** /push-devices/{pushDeviceId} | Get a registered push device|
|[**getPushDevices**](#getpushdevices) | **GET** /push-devices | List registered push devices|

# **deletePushDevice**
> CreateAccountInvitations200Response deletePushDevice()

Removes a mobile push device registration by its ID so it no longer receives push notifications, requires read and update permissions on accounts.

### Example

```typescript
import {
    PushDevicesApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new PushDevicesApi(configuration);

let pushDeviceId: string; //The pushDevice identifier (default to undefined)

const { status, data } = await apiInstance.deletePushDevice(
    pushDeviceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **pushDeviceId** | [**string**] | The pushDevice identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getPushDevice**
> GetPushDevice200Response getPushDevice()

Retrieves a single registered push notification device by its ID, including its device token and associated account; requires read permission on the accounts resource.

### Example

```typescript
import {
    PushDevicesApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new PushDevicesApi(configuration);

let pushDeviceId: string; //The pushDevice identifier (default to undefined)

const { status, data } = await apiInstance.getPushDevice(
    pushDeviceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **pushDeviceId** | [**string**] | The pushDevice identifier | defaults to undefined|


### Return type

**GetPushDevice200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getPushDevices**
> GetLoginDevices200Response getPushDevices()

Returns a paginated, searchable list of registered push notification devices across the organization, optionally filtered to a single account by accountId and sortable via orderBy; requires read permission on the accounts resource.

### Example

```typescript
import {
    PushDevicesApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new PushDevicesApi(configuration);

let accountId: string; //Filter by accountId (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getPushDevices(
    accountId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **accountId** | [**string**] | Filter by accountId | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetLoginDevices200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)