
## Quote fields

`GET /v1/quotes/fields`

Returns the full list of available fields, including user fields (`ufCrm_*`).

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/quotes/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth app

```bash
curl "https://vibecode.bitrix24.com/v1/quotes/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/quotes/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data).length)
```

### JavaScript — OAuth app

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/quotes/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Response fields

| Field | Bitrix24 | Type | RO | Description |
|------|----------|-----|:--:|---------|
| `id` | `id` | number | yes | Quote ID |
| `quoteNumber` | `quoteNumber` | string | | Quote number |
| `title` | `title` | string | | Name |
| `amount` | `opportunity` | number | | Amount |
| `taxValue` | `taxValue` | number | | Tax value |
| `currency` | `currencyId` | string | | Currency. List: `GET /v1/currencies` |
| `stageId` | `stageId` | string | | Status: `DRAFT`, `SENT`, `APPROVED`. List: `GET /v1/statuses?filter[entityId]=QUOTE_STATUS` |
| `isManualOpportunity` | `isManualOpportunity` | boolean | | Manual amount mode (`Y`/`N` in Bitrix24, converted to boolean) |
| `opened` | `opened` | boolean | | Available to everyone |
| `closed` | `closed` | boolean | yes | Quote is closed |
| `dealId` | `dealId` | number | | Deal ID. Lookup: `GET /v1/deals` |
| `leadId` | `leadId` | number | | Lead ID. Lookup: `GET /v1/leads` |
| `contactId` | `contactId` | number | | Contact ID. Lookup: `GET /v1/contacts` |
| `contactIds` | `contactIds` | array | yes | Quote contact IDs (the binding is not managed via `crm.item.update`) |
| `contacts` | `contacts` | array | yes | Quote contacts |
| `companyId` | `companyId` | number | | Company ID. Lookup: `GET /v1/companies` |
| `mycompanyId` | `mycompanyId` | number | | Your company details |
| `personTypeId` | `personTypeId` | number | yes | Payer type |
| `assignedById` | `assignedById` | number | | Assignee. List: `GET /v1/users` |
| `createdBy` | `createdBy` | number | yes | Creator. Lookup: `GET /v1/users` |
| `updatedBy` | `updatedBy` | number | yes | Updated by |
| `lastActivityBy` | `lastActivityBy` | number | | Last activity author |
| `comments` | `comments` | string | | Comment |
| `content` | `content` | string | | Content |
| `terms` | `terms` | string | | Terms |
| `locationId` | `locationId` | string | | Location |
| `webformId` | `webformId` | number | | Created by a CRM web form |
| `storageTypeId` | `storageTypeId` | number | | File storage type |
| `storageElementIds` | `storageElementIds` | array | | Storage file IDs |
| `utmSource` | `utmSource` | string | | UTM source |
| `utmMedium` | `utmMedium` | string | | UTM medium |
| `utmCampaign` | `utmCampaign` | string | | UTM campaign |
| `utmContent` | `utmContent` | string | | UTM content |
| `utmTerm` | `utmTerm` | string | | UTM term |
| `beginDate` | `begindate` | datetime | | Start date |
| `closeDate` | `closedate` | datetime | | Close date |
| `actualDate` | `actualDate` | datetime | | Valid until |
| `lastActivityTime` | `lastActivityTime` | datetime | | Last activity |
| `lastCommunicationTime` | `lastCommunicationTime` | string | yes | Last communication date |
| `lastCommunicationCallTime` | `lastCommunicationCallTime` | datetime | yes | Last call date |
| `lastCommunicationEmailTime` | `lastCommunicationEmailTime` | datetime | yes | Last email date |
| `lastCommunicationImolTime` | `lastCommunicationImolTime` | datetime | yes | Last open-line dialog date |
| `lastCommunicationWebformTime` | `lastCommunicationWebformTime` | datetime | yes | Last CRM web-form submission date |
| `createdTime` | `createdTime` | datetime | yes | Creation date |
| `updatedTime` | `updatedTime` | datetime | yes | Modification date |

**User fields** (`ufCrm_*`) are also returned in responses and accepted on create/update.



## Available include

The `GET /v1/quotes/fields` endpoint returns the list of available include: `deal`, `contact`, `company`.

Usage example: [Get quotes](/docs/entities/quotes/get#related-data).

More about include: [Related data](/docs/includes).


## Response example

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "title": { "type": "string", "readonly": false },
      "assignedById": { "type": "number", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

Only 3 of the many fields are shown. The full list is in the table above.

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | The API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Create a quote](/docs/entities/quotes/create) — which fields to pass
- [User fields](/docs/userfields) — creating and managing `ufCrm_*`
- [Entity API](/docs/entity-api) — select for fetching the fields you need
- [Limits and optimization](/docs/optimization) — rate limits
