---
name: "authQuantityReadPermissions"
mode: "kit"
versionRequirements:
  - { name: "HealthKit", version: "5.18.3" }
  - { name: "@ray-js/ray", version: "1.6.17" }
platform:
  - "iOS"
async: true
title: "health.authQuantityReadPermissions - Request Quantity read permissions [iOS only]"
---

## authQuantityReadPermissions

> [VERSION] HealthKit >= 5.18.3 | @ray-js/ray >= 1.6.17

> [PLATFORM] iOS

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Request read permission for Quantity data types [iOS only]

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `permissions` | `string[]` | No | - | `5.18.3` | Permission types (used by the API that requests read/write permissions). See the enum list below for values. e.g. ["1","2"] |
| `readPermissions` | `string[]` | No | - | `5.18.3` | Read permission types (used by the API that checks whether the user has granted authorization). See the enum list below for values. e.g. ["1","2"] |
| `writePermissions` | `string[]` | No | - | `5.18.3` | Write permission types (used by the API that checks whether the user has granted authorization). See the enum list below for values. e.g. ["1","2"] |
| `writePermission` | `number` | No | - | `5.18.3` | Write permission types (used by the API that checks for write permission). See the enum list below for values. |
| `value` | `number` | No | - | `5.18.3` | Value to write (the specific measurement for Quantity or Category data). |
| `unitType` | `string` | No | - | `5.18.3` | Unit to pass in, e.g., "mg/dL", "g", "cm", "count"; required when reading or writing Quantity data. For the units corresponding to each data type, refer to Apple's official HKTypeIdentifiers.h file. |
| `startTime` | `number` | No | - | `5.18.3` | Start time, timestamp in seconds. |
| `endTime` | `number` | No | - | `5.18.3` | End time, timestamp in seconds. |
| `type` | `number` | No | - | `5.18.3` | Data types to read/write (used by the data read/write APIs). See the enum list below for values. |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Error Codes

| Error Code | Error Message |
| --- | --- |
| `1` | AppleHealthParamsError |

### Examples

#### Basic call

```tsx
import { health } from '@ray-js/ray'

const { authQuantityReadPermissions } = health;

authQuantityReadPermissions({
  permissions: ['1', '2'],
  success: () => {
    console.log('authQuantityReadPermissions success');
  },
  fail: (error) => {
    console.log('authQuantityReadPermissions fail', error.errorMsg);
  },
});
```