# List company providers

`GET /v1/sign-b2e/company-providers`

Returns the signature providers of your own company. Requires permission to create documents. Reading can automatically register virtual providers; automatic retries are disabled.

**Scopes:** `sign.b2e`, `crm`.

## Query parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| `companyCrmId` | integer \| string | no | Your own company ID from the [list of companies](/docs/entities/companies). Pass either this or companyUuid. |
| `companyUuid` | string | no | HCM Link company UUID. Requires humanresources.hcmlink; used instead of companyCrmId. |
| `limit` | integer \| string | no | Defaults to 100; from 1 to 1000. Bitrix24 rejects values outside this range. |
| `offset` | integer \| string | no | Offset from the start of the list; 0 by default. |
| `language` | string | no | Language of provider names, en by default; an unknown language is replaced with en. |

## Examples

### curl — personal key

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7' \
  -H 'X-Api-Key: YOUR_API_KEY'
```

### curl — OAuth application

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'
```

### JavaScript — personal key

```javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
```

### JavaScript — OAuth application

```javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
```

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | Whether the request succeeded. |
| `data` | array<object> | Operation data. |
| `data[].code` | string | Machine-readable code. |
| `data[].uid` | string | Company provider UID used to send a document. |
| `data[].name` | string | State name or user name. |
| `data[].date` | string \| null | Provider connection date in ATOM format, or null. |
| `data[].expires` | string \| null | Provider expiry date in ATOM format, or null. |
| `meta.redacted` | array<string> | Present when credentials are hidden; contains the paths of the replaced values. |

## Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

```json
{
  "success": true,
  "data": []
}
```

## Error response example

403 — the key lacks a required scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}
```

## Errors

| HTTP | Code | Reason |
|---|---|---|
| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |
| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |
| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is READONLY: the native read can register virtual providers. |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |

[Common API errors](/docs/errors).

## Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

The operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; repeating the call can repeat the operation.

Although this is a GET request, it requires a READWRITE key. The Bitrix24 core can trigger company registration with a provider (`sign/lib/Rest/B2e/CompanyProvider.php:118,323–343`), so the standard write block rejects a READONLY key before Bitrix24 is called. Automatic retries are disabled both in the classifier and in the request-processing pipeline.

## See also

- [Employee signatures](/docs/sign-b2e)
- [API errors](/docs/errors)
