Get Requisites and Contacts of My Company v 3.0 crm.mycompany.basic.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with permission to view companies, invoices, CRM documents, or B2E documents — permission for any one of these object types is enough
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The crm.mycompany.basic.get method returns the basic data of my company by ID: the name, phone numbers, email addresses, requisites, and bank details.
The method is available without the CRM administrator permissions required by the crm.mycompany.get method. For example, an employee who works only with invoices or documents can retrieve the data of their company.
Differences from crm.mycompany.get
|
Compared |
crm.mycompany.basic.get |
crm.mycompany.get |
|
Who can call |
A user with permission to view companies, invoices, CRM documents, or B2E documents |
CRM administrator |
|
Fields |
Only |
All my company fields except requisites, including custom fields. My company fields |
|
Requisites |
Requisites and bank details in the response |
No. The requisites of my company are returned by the crm.requisite.list method with a filter by |
|
Response without |
|
Only |
|
Company not found |
HTTP status 404 |
HTTP status 400 |
The method returns only companies from the "My companies" list. The ID of a regular company causes the BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION error.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
ID of my company. IDs can be retrieved with the crm.mycompany.basic.list method |
|
select |
List of fields to return. Parameter description Default: |
The select Parameter
Available fields:
id— company IDtitle— company nameemail— email addressesphone— phone numbersrequisites— company requisitesbankRequisites— company bank details
Fields of nested objects can be selected using dot notation: phone.value, requisites.inn, bankRequisites.bankName. The whole object name, for example, requisites, returns all of its fields.
Other fields, for example, createdTime, cause the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error. Descriptions of the available fields are returned by the crm.mycompany.basic.field.list and crm.mycompany.basic.field.get methods.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.mycompany.basic.get
The examples retrieve the name, phone numbers, email addresses, the tax ID (INN) from the requisites, and the bank names of my company with ID 3.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3,"select":["id","title","phone","email","requisites.id","requisites.presetId","requisites.companyTitle","requisites.inn","bankRequisites.id","bankRequisites.bankName"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.mycompany.basic.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":3,"select":["id","title","phone","email","requisites.id","requisites.presetId","requisites.companyTitle","requisites.inn","bankRequisites.id","bankRequisites.bankName"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.mycompany.basic.get
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type Multifield = {
id: number
valueTypeId: string
value: string
}
type MyCompanyBasicGetResult = {
item: {
id: number
title: string
phone: Multifield[]
email: Multifield[]
requisites: { id: number, presetId: number, companyTitle: string, inn: string }[]
bankRequisites: { id: number, bankName: string | null }[]
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<MyCompanyBasicGetResult>(
'crm.mycompany.basic.get',
{
id: 3,
select: [
'id',
'title',
'phone',
'email',
'requisites.id',
'requisites.presetId',
'requisites.companyTitle',
'requisites.inn',
'bankRequisites.id',
'bankRequisites.bankName',
],
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const company = response.getData()!.result.item
console.info(company.title, company.requisites.map(requisite => requisite.inn))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getMyCompany() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.mycompany.basic.get',
{
id: 3,
select: [
'id',
'title',
'phone',
'email',
'requisites.id',
'requisites.presetId',
'requisites.companyTitle',
'requisites.inn',
'bankRequisites.id',
'bankRequisites.bankName',
],
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const company = response.getData().result.item
console.info(company.title, company.requisites.map(requisite => requisite.inn))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getMyCompany)
</script>
b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.mycompany.basic.get"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"id": 3,
"select": [
"id",
"title",
"phone",
"email",
"requisites.id",
"requisites.presetId",
"requisites.companyTitle",
"requisites.inn",
"bankRequisites.id",
"bankRequisites.bankName",
],
},
prefer_version=3,
)
company = response["result"]["item"]
print(company["title"], [requisite["inn"] for requisite in company["requisites"]])
except BitrixAPIError as error:
print(
"Bitrix API error",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'crm.mycompany.basic.get',
[
'id' => 3,
'select' => [
'id',
'title',
'phone',
'email',
'requisites.id',
'requisites.presetId',
'requisites.companyTitle',
'requisites.inn',
'bankRequisites.id',
'bankRequisites.bankName',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'crm.mycompany.basic.get',
{
id: 3,
select: [
'id',
'title',
'phone',
'email',
'requisites.id',
'requisites.presetId',
'requisites.companyTitle',
'requisites.inn',
'bankRequisites.id',
'bankRequisites.bankName',
],
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'crm.mycompany.basic.get',
[
'id' => 3,
'select' => [
'id',
'title',
'phone',
'email',
'requisites.id',
'requisites.presetId',
'requisites.companyTitle',
'requisites.inn',
'bankRequisites.id',
'bankRequisites.bankName',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.mycompany.basic.get", b24.Params{
"id": 3,
"select": []string{
"id", "title", "phone", "email",
"requisites.id", "requisites.presetId", "requisites.companyTitle", "requisites.inn",
"bankRequisites.id", "bankRequisites.bankName",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.mycompany.basic.get: %w", err)
}
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
var company struct {
ID int `json:"id"`
Title string `json:"title"`
Requisites []struct {
ID int `json:"id"`
CompanyTitle string `json:"companyTitle"`
Inn string `json:"inn"`
} `json:"requisites"`
}
if err := json.Unmarshal(raw, &company); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(company.ID, company.Title, len(company.Requisites))
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 3,
"title": "Müller GmbH",
"email": [
{
"id": 7605,
"valueTypeId": "WORK",
"valueType": {
"id": "WORK",
"name": "Work E-mail",
"nameShort": "Work"
},
"value": "info@example.com"
}
],
"phone": [
{
"id": 7637,
"valueTypeId": "WORK",
"valueType": {
"id": "WORK",
"name": "Work Phone",
"nameShort": "Work Phone"
},
"value": "+49300000000"
}
],
"requisites": [
{
"id": 3,
"presetId": 1,
"companyTitle": "Müller GmbH",
"inn": "7700000000"
},
{
"id": 49,
"presetId": 1,
"companyTitle": "Müller Service GmbH",
"inn": "7700000001"
}
],
"bankRequisites": [
{
"id": 3,
"bankName": "Main account"
}
]
}
},
"time": {
"start": 1793706809,
"finish": 1793706809.06065,
"duration": 0.06065011024475098,
"processing": 0,
"date_start": "2026-11-03T14:53:29+03:00",
"date_finish": "2026-11-03T14:53:29+03:00",
"operating_reset_at": 1793707380,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.item |
Data of my company. Contains only the fields from |
|
time |
Information about the request execution time |
The item Object
|
Name |
Description |
|
id |
Company ID |
|
title |
Company name |
|
email |
Email addresses. Element description. If there are no addresses, an empty array |
|
phone |
Phone numbers. Element description. If there are no phone numbers, an empty array |
|
requisites |
Company requisites. The requisite fields are the same as those returned by the crm.requisite.list method: |
|
bankRequisites |
Bank details of all company requisites. Element description. If there are no bank details, an empty array |
The email and phone Element
|
Name |
Description |
|
id |
Value ID |
|
valueTypeId |
Value type, for example, |
|
valueType |
Value type: |
|
value |
Email address or phone number |
The bankRequisites Element
|
Name |
Description |
|
id |
Bank details ID |
|
requisiteId |
ID of the requisite the bank details belong to |
|
name |
Bank details name |
|
bankName |
Bank name |
|
bankAddress |
Bank address |
|
bik |
BIC |
|
bankAccountNumber |
Account number |
|
bankAccountCurrency |
Account currency |
|
correspondentAccountNumber |
Correspondent account |
|
swift |
SWIFT |
|
comments |
Comment |
Bank details fields that are not filled in are returned as null. For more information about bank details, see the description of the crm.<type>.requisite.bankrequisite.get method.
Error Handling
HTTP status: 404
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 1 was not found."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Company Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Entity with ID #ID# was not found |
There is no company with this |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the company |
|
|
This request requires data type |
Pass the ID as a number |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass in |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
The user has no permission to view companies, invoices, CRM documents, or B2E documents |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |