GET api/Company/{id}

Fast method to get company or private person by id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

ApiCompany

Name	Description	Type	Additional information
id		integer	None.
name	If 'is_private_person' = true, field readonly. Use only for company 'is_private_person' = false.	string	None.
first_name		string	None.
last_name		string	None.
middle_name		string	None.
is_private_person		boolean	None.
is_customer		boolean	None.
is_vendor		boolean	None.
is_disabled		boolean	None.
id_parent		integer	None.
desc		string	None.
registration		string	None.
kpp		string	None.
url		string	None.
birthday		date	None.
dt_added		date	None.
gender		integer	None.
funnel_step_id		integer	None.
outer_id		string	None.
company_address		Collection of string	None.
company_contact_edit		boolean	None.
company_contact_link		Collection of ContactLink	None.
company_info_edit	Enables company_info edditing	boolean	None.
company_info		Collection of ContactInfo	None.
company_att	List of attachments Get by using File-GET(id: id, type: 1)	Collection of Object	None.
category		Collection of CategoryInfo	None.
company_person_edit	Enable to change edit delete - company_person	boolean	None.
company_person	Contains List of responsibles	Collection of CompanyPerson	None.
customMasterFields		ApiMasterFields	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "first_name": "sample string 3",
  "last_name": "sample string 4",
  "middle_name": "sample string 5",
  "is_private_person": true,
  "is_customer": true,
  "is_vendor": true,
  "is_disabled": true,
  "id_parent": 1,
  "desc": "sample string 10",
  "registration": "sample string 11",
  "kpp": "sample string 12",
  "url": "sample string 13",
  "birthday": "2024-11-16T04:54:22.61428+00:00",
  "dt_added": "2024-11-16T04:54:22.61428+00:00",
  "gender": 1,
  "funnel_step_id": 1,
  "outer_id": "sample string 14",
  "company_address": [
    "sample string 1",
    "sample string 2"
  ],
  "company_contact_edit": true,
  "company_contact_link": [
    {
      "id": 1,
      "post": "sample string 2",
      "contact": {
        "id": 1,
        "first_name": "sample string 2",
        "middle_name": "sample string 3",
        "last_name": "sample string 4",
        "description": "sample string 5",
        "color": "sample string 6",
        "birthday": "2024-11-16T04:54:22.61428+00:00",
        "gender": 1,
        "in_archive": true,
        "contact_info": [
          {
            "id": 1,
            "type": 0,
            "additional_type": 0,
            "data_string": "sample string 2",
            "is_subscribed": true
          },
          {
            "id": 1,
            "type": 0,
            "additional_type": 0,
            "data_string": "sample string 2",
            "is_subscribed": true
          }
        ]
      }
    },
    {
      "id": 1,
      "post": "sample string 2",
      "contact": {
        "id": 1,
        "first_name": "sample string 2",
        "middle_name": "sample string 3",
        "last_name": "sample string 4",
        "description": "sample string 5",
        "color": "sample string 6",
        "birthday": "2024-11-16T04:54:22.61428+00:00",
        "gender": 1,
        "in_archive": true,
        "contact_info": [
          {
            "id": 1,
            "type": 0,
            "additional_type": 0,
            "data_string": "sample string 2",
            "is_subscribed": true
          },
          {
            "id": 1,
            "type": 0,
            "additional_type": 0,
            "data_string": "sample string 2",
            "is_subscribed": true
          }
        ]
      }
    }
  ],
  "company_info_edit": true,
  "company_info": [
    {
      "id": 1,
      "type": 0,
      "additional_type": 0,
      "data_string": "sample string 2",
      "is_subscribed": true
    },
    {
      "id": 1,
      "type": 0,
      "additional_type": 0,
      "data_string": "sample string 2",
      "is_subscribed": true
    }
  ],
  "company_att": [
    {},
    {}
  ],
  "category": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "company_person_edit": true,
  "company_person": [
    {
      "id": 1,
      "id_person": 2,
      "role": "sample string 3"
    },
    {
      "id": 1,
      "id_person": 2,
      "role": "sample string 3"
    }
  ],
  "customMasterFields": {
    "_fields": [
      {
        "_custom_field": {
          "id": 1,
          "number": 2,
          "name": "sample string 3",
          "type": 4,
          "show": true,
          "description": "sample string 6",
          "is_required": true,
          "is_main": true,
          "is_deleted": true
        },
        "_field_data_id": 1,
        "_integer_data": 1,
        "_text_data": "sample string 2",
        "_datetime_data": "2024-11-16T04:54:22.61428+00:00",
        "_bit_data": true,
        "_floating_data": 1.1,
        "_custom_field_address": [
          {
            "address": {
              "id": 1,
              "street_number": "sample string 2",
              "route": "sample string 3",
              "locality": "sample string 4",
              "aal1": "sample string 5",
              "aal2": "sample string 6",
              "country": "sample string 7",
              "postal_code": "sample string 8",
              "is_main": true,
              "is_default_billing": true,
              "is_default_delivery": true,
              "full_address": "sample string 12",
              "comment": "sample string 13",
              "verification": true,
              "is_subscribed": true
            },
            "json": "sample string 1",
            "is_mark_delete": true
          },
          {
            "address": {
              "id": 1,
              "street_number": "sample string 2",
              "route": "sample string 3",
              "locality": "sample string 4",
              "aal1": "sample string 5",
              "aal2": "sample string 6",
              "country": "sample string 7",
              "postal_code": "sample string 8",
              "is_main": true,
              "is_default_billing": true,
              "is_default_delivery": true,
              "full_address": "sample string 12",
              "comment": "sample string 13",
              "verification": true,
              "is_subscribed": true
            },
            "json": "sample string 1",
            "is_mark_delete": true
          }
        ],
        "_custom_field_url": [
          {
            "Main": {
              "id": 1,
              "url": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          },
          {
            "Main": {
              "id": 1,
              "url": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          }
        ],
        "_custom_field_phone": [
          {
            "Main": {
              "id": 1,
              "phone": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          },
          {
            "Main": {
              "id": 1,
              "phone": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          }
        ],
        "_custom_field_checklist_item": [
          {
            "checkListItem": {
              "id": 1,
              "name": "sample string 2",
              "is_complete": true,
              "created_date": "2024-11-16T04:54:22.61428+00:00",
              "due_date": "2024-11-16T04:54:22.61428+00:00",
              "complete_date": "2024-11-16T04:54:22.61428+00:00"
            },
            "is_mark_delete": true
          },
          {
            "checkListItem": {
              "id": 1,
              "name": "sample string 2",
              "is_complete": true,
              "created_date": "2024-11-16T04:54:22.61428+00:00",
              "due_date": "2024-11-16T04:54:22.61428+00:00",
              "complete_date": "2024-11-16T04:54:22.61428+00:00"
            },
            "is_mark_delete": true
          }
        ]
      },
      {
        "_custom_field": {
          "id": 1,
          "number": 2,
          "name": "sample string 3",
          "type": 4,
          "show": true,
          "description": "sample string 6",
          "is_required": true,
          "is_main": true,
          "is_deleted": true
        },
        "_field_data_id": 1,
        "_integer_data": 1,
        "_text_data": "sample string 2",
        "_datetime_data": "2024-11-16T04:54:22.61428+00:00",
        "_bit_data": true,
        "_floating_data": 1.1,
        "_custom_field_address": [
          {
            "address": {
              "id": 1,
              "street_number": "sample string 2",
              "route": "sample string 3",
              "locality": "sample string 4",
              "aal1": "sample string 5",
              "aal2": "sample string 6",
              "country": "sample string 7",
              "postal_code": "sample string 8",
              "is_main": true,
              "is_default_billing": true,
              "is_default_delivery": true,
              "full_address": "sample string 12",
              "comment": "sample string 13",
              "verification": true,
              "is_subscribed": true
            },
            "json": "sample string 1",
            "is_mark_delete": true
          },
          {
            "address": {
              "id": 1,
              "street_number": "sample string 2",
              "route": "sample string 3",
              "locality": "sample string 4",
              "aal1": "sample string 5",
              "aal2": "sample string 6",
              "country": "sample string 7",
              "postal_code": "sample string 8",
              "is_main": true,
              "is_default_billing": true,
              "is_default_delivery": true,
              "full_address": "sample string 12",
              "comment": "sample string 13",
              "verification": true,
              "is_subscribed": true
            },
            "json": "sample string 1",
            "is_mark_delete": true
          }
        ],
        "_custom_field_url": [
          {
            "Main": {
              "id": 1,
              "url": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          },
          {
            "Main": {
              "id": 1,
              "url": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          }
        ],
        "_custom_field_phone": [
          {
            "Main": {
              "id": 1,
              "phone": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          },
          {
            "Main": {
              "id": 1,
              "phone": "sample string 2",
              "name": "sample string 3"
            },
            "is_mark_delete": true
          }
        ],
        "_custom_field_checklist_item": [
          {
            "checkListItem": {
              "id": 1,
              "name": "sample string 2",
              "is_complete": true,
              "created_date": "2024-11-16T04:54:22.61428+00:00",
              "due_date": "2024-11-16T04:54:22.61428+00:00",
              "complete_date": "2024-11-16T04:54:22.61428+00:00"
            },
            "is_mark_delete": true
          },
          {
            "checkListItem": {
              "id": 1,
              "name": "sample string 2",
              "is_complete": true,
              "created_date": "2024-11-16T04:54:22.61428+00:00",
              "due_date": "2024-11-16T04:54:22.61428+00:00",
              "complete_date": "2024-11-16T04:54:22.61428+00:00"
            },
            "is_mark_delete": true
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ApiCompany xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <id>1</id>
  <name>sample string 2</name>
  <first_name>sample string 3</first_name>
  <last_name>sample string 4</last_name>
  <middle_name>sample string 5</middle_name>
  <is_private_person>true</is_private_person>
  <is_customer>true</is_customer>
  <is_vendor>true</is_vendor>
  <is_disabled>true</is_disabled>
  <id_parent>1</id_parent>
  <desc>sample string 10</desc>
  <registration>sample string 11</registration>
  <kpp>sample string 12</kpp>
  <url>sample string 13</url>
  <birthday>2024-11-16T04:54:22.61428+00:00</birthday>
  <dt_added>2024-11-16T04:54:22.61428+00:00</dt_added>
  <gender>1</gender>
  <funnel_step_id>1</funnel_step_id>
  <outer_id>sample string 14</outer_id>
  <company_address>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </company_address>
  <company_contact_edit>true</company_contact_edit>
  <company_contact_link>
    <ContactLink>
      <id>1</id>
      <post>sample string 2</post>
      <contact>
        <id>1</id>
        <first_name>sample string 2</first_name>
        <middle_name>sample string 3</middle_name>
        <last_name>sample string 4</last_name>
        <description>sample string 5</description>
        <color>sample string 6</color>
        <birthday>2024-11-16T04:54:22.61428+00:00</birthday>
        <gender>1</gender>
        <in_archive>true</in_archive>
        <contact_info>
          <ContactInfo>
            <id>1</id>
            <type>Phone</type>
            <additional_type>Phone_Mobile</additional_type>
            <data_string>sample string 2</data_string>
            <is_subscribed>true</is_subscribed>
          </ContactInfo>
          <ContactInfo>
            <id>1</id>
            <type>Phone</type>
            <additional_type>Phone_Mobile</additional_type>
            <data_string>sample string 2</data_string>
            <is_subscribed>true</is_subscribed>
          </ContactInfo>
        </contact_info>
      </contact>
    </ContactLink>
    <ContactLink>
      <id>1</id>
      <post>sample string 2</post>
      <contact>
        <id>1</id>
        <first_name>sample string 2</first_name>
        <middle_name>sample string 3</middle_name>
        <last_name>sample string 4</last_name>
        <description>sample string 5</description>
        <color>sample string 6</color>
        <birthday>2024-11-16T04:54:22.61428+00:00</birthday>
        <gender>1</gender>
        <in_archive>true</in_archive>
        <contact_info>
          <ContactInfo>
            <id>1</id>
            <type>Phone</type>
            <additional_type>Phone_Mobile</additional_type>
            <data_string>sample string 2</data_string>
            <is_subscribed>true</is_subscribed>
          </ContactInfo>
          <ContactInfo>
            <id>1</id>
            <type>Phone</type>
            <additional_type>Phone_Mobile</additional_type>
            <data_string>sample string 2</data_string>
            <is_subscribed>true</is_subscribed>
          </ContactInfo>
        </contact_info>
      </contact>
    </ContactLink>
  </company_contact_link>
  <company_info_edit>true</company_info_edit>
  <company_info>
    <ContactInfo>
      <id>1</id>
      <type>Phone</type>
      <additional_type>Phone_Mobile</additional_type>
      <data_string>sample string 2</data_string>
      <is_subscribed>true</is_subscribed>
    </ContactInfo>
    <ContactInfo>
      <id>1</id>
      <type>Phone</type>
      <additional_type>Phone_Mobile</additional_type>
      <data_string>sample string 2</data_string>
      <is_subscribed>true</is_subscribed>
    </ContactInfo>
  </company_info>
  <company_att>
    <anyType />
    <anyType />
  </company_att>
  <category>
    <CategoryInfo>
      <id>1</id>
      <name>sample string 2</name>
    </CategoryInfo>
    <CategoryInfo>
      <id>1</id>
      <name>sample string 2</name>
    </CategoryInfo>
  </category>
  <company_person_edit>true</company_person_edit>
  <company_person>
    <CompanyPerson>
      <id>1</id>
      <id_person>2</id_person>
      <role>sample string 3</role>
    </CompanyPerson>
    <CompanyPerson>
      <id>1</id>
      <id_person>2</id_person>
      <role>sample string 3</role>
    </CompanyPerson>
  </company_person>
  <customMasterFields>
    <_fields>
      <ApiCompanyCustomDataPOST>
        <_custom_field>
          <id>1</id>
          <number>2</number>
          <name>sample string 3</name>
          <type>4</type>
          <show>true</show>
          <description>sample string 6</description>
          <is_required>true</is_required>
          <is_main>true</is_main>
          <is_deleted>true</is_deleted>
        </_custom_field>
        <_field_data_id>1</_field_data_id>
        <_integer_data>1</_integer_data>
        <_text_data>sample string 2</_text_data>
        <_datetime_data>2024-11-16T04:54:22.61428+00:00</_datetime_data>
        <_bit_data>true</_bit_data>
        <_floating_data>1.1</_floating_data>
        <_custom_field_address>
          <ApiCompanyCustomDataGoogleAddressPOST>
            <address>
              <id>1</id>
              <street_number>sample string 2</street_number>
              <route>sample string 3</route>
              <locality>sample string 4</locality>
              <aal1>sample string 5</aal1>
              <aal2>sample string 6</aal2>
              <country>sample string 7</country>
              <postal_code>sample string 8</postal_code>
              <is_main>true</is_main>
              <is_default_billing>true</is_default_billing>
              <is_default_delivery>true</is_default_delivery>
              <full_address>sample string 12</full_address>
              <comment>sample string 13</comment>
              <verification>true</verification>
              <is_subscribed>true</is_subscribed>
            </address>
            <json>sample string 1</json>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataGoogleAddressPOST>
          <ApiCompanyCustomDataGoogleAddressPOST>
            <address>
              <id>1</id>
              <street_number>sample string 2</street_number>
              <route>sample string 3</route>
              <locality>sample string 4</locality>
              <aal1>sample string 5</aal1>
              <aal2>sample string 6</aal2>
              <country>sample string 7</country>
              <postal_code>sample string 8</postal_code>
              <is_main>true</is_main>
              <is_default_billing>true</is_default_billing>
              <is_default_delivery>true</is_default_delivery>
              <full_address>sample string 12</full_address>
              <comment>sample string 13</comment>
              <verification>true</verification>
              <is_subscribed>true</is_subscribed>
            </address>
            <json>sample string 1</json>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataGoogleAddressPOST>
        </_custom_field_address>
        <_custom_field_url>
          <ApiCompanyCustomDataUrlPOST>
            <Main>
              <id>1</id>
              <url>sample string 2</url>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataUrlPOST>
          <ApiCompanyCustomDataUrlPOST>
            <Main>
              <id>1</id>
              <url>sample string 2</url>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataUrlPOST>
        </_custom_field_url>
        <_custom_field_phone>
          <ApiCompanyCustomDataPhonePOST>
            <Main>
              <id>1</id>
              <phone>sample string 2</phone>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataPhonePOST>
          <ApiCompanyCustomDataPhonePOST>
            <Main>
              <id>1</id>
              <phone>sample string 2</phone>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataPhonePOST>
        </_custom_field_phone>
        <_custom_field_checklist_item>
          <ApiCompanyCustomDataCheckListItemPOST>
            <checkListItem>
              <id>1</id>
              <name>sample string 2</name>
              <is_complete>true</is_complete>
              <created_date>2024-11-16T04:54:22.61428+00:00</created_date>
              <due_date>2024-11-16T04:54:22.61428+00:00</due_date>
              <complete_date>2024-11-16T04:54:22.61428+00:00</complete_date>
            </checkListItem>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataCheckListItemPOST>
          <ApiCompanyCustomDataCheckListItemPOST>
            <checkListItem>
              <id>1</id>
              <name>sample string 2</name>
              <is_complete>true</is_complete>
              <created_date>2024-11-16T04:54:22.61428+00:00</created_date>
              <due_date>2024-11-16T04:54:22.61428+00:00</due_date>
              <complete_date>2024-11-16T04:54:22.61428+00:00</complete_date>
            </checkListItem>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataCheckListItemPOST>
        </_custom_field_checklist_item>
      </ApiCompanyCustomDataPOST>
      <ApiCompanyCustomDataPOST>
        <_custom_field>
          <id>1</id>
          <number>2</number>
          <name>sample string 3</name>
          <type>4</type>
          <show>true</show>
          <description>sample string 6</description>
          <is_required>true</is_required>
          <is_main>true</is_main>
          <is_deleted>true</is_deleted>
        </_custom_field>
        <_field_data_id>1</_field_data_id>
        <_integer_data>1</_integer_data>
        <_text_data>sample string 2</_text_data>
        <_datetime_data>2024-11-16T04:54:22.61428+00:00</_datetime_data>
        <_bit_data>true</_bit_data>
        <_floating_data>1.1</_floating_data>
        <_custom_field_address>
          <ApiCompanyCustomDataGoogleAddressPOST>
            <address>
              <id>1</id>
              <street_number>sample string 2</street_number>
              <route>sample string 3</route>
              <locality>sample string 4</locality>
              <aal1>sample string 5</aal1>
              <aal2>sample string 6</aal2>
              <country>sample string 7</country>
              <postal_code>sample string 8</postal_code>
              <is_main>true</is_main>
              <is_default_billing>true</is_default_billing>
              <is_default_delivery>true</is_default_delivery>
              <full_address>sample string 12</full_address>
              <comment>sample string 13</comment>
              <verification>true</verification>
              <is_subscribed>true</is_subscribed>
            </address>
            <json>sample string 1</json>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataGoogleAddressPOST>
          <ApiCompanyCustomDataGoogleAddressPOST>
            <address>
              <id>1</id>
              <street_number>sample string 2</street_number>
              <route>sample string 3</route>
              <locality>sample string 4</locality>
              <aal1>sample string 5</aal1>
              <aal2>sample string 6</aal2>
              <country>sample string 7</country>
              <postal_code>sample string 8</postal_code>
              <is_main>true</is_main>
              <is_default_billing>true</is_default_billing>
              <is_default_delivery>true</is_default_delivery>
              <full_address>sample string 12</full_address>
              <comment>sample string 13</comment>
              <verification>true</verification>
              <is_subscribed>true</is_subscribed>
            </address>
            <json>sample string 1</json>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataGoogleAddressPOST>
        </_custom_field_address>
        <_custom_field_url>
          <ApiCompanyCustomDataUrlPOST>
            <Main>
              <id>1</id>
              <url>sample string 2</url>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataUrlPOST>
          <ApiCompanyCustomDataUrlPOST>
            <Main>
              <id>1</id>
              <url>sample string 2</url>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataUrlPOST>
        </_custom_field_url>
        <_custom_field_phone>
          <ApiCompanyCustomDataPhonePOST>
            <Main>
              <id>1</id>
              <phone>sample string 2</phone>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataPhonePOST>
          <ApiCompanyCustomDataPhonePOST>
            <Main>
              <id>1</id>
              <phone>sample string 2</phone>
              <name>sample string 3</name>
            </Main>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataPhonePOST>
        </_custom_field_phone>
        <_custom_field_checklist_item>
          <ApiCompanyCustomDataCheckListItemPOST>
            <checkListItem>
              <id>1</id>
              <name>sample string 2</name>
              <is_complete>true</is_complete>
              <created_date>2024-11-16T04:54:22.61428+00:00</created_date>
              <due_date>2024-11-16T04:54:22.61428+00:00</due_date>
              <complete_date>2024-11-16T04:54:22.61428+00:00</complete_date>
            </checkListItem>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataCheckListItemPOST>
          <ApiCompanyCustomDataCheckListItemPOST>
            <checkListItem>
              <id>1</id>
              <name>sample string 2</name>
              <is_complete>true</is_complete>
              <created_date>2024-11-16T04:54:22.61428+00:00</created_date>
              <due_date>2024-11-16T04:54:22.61428+00:00</due_date>
              <complete_date>2024-11-16T04:54:22.61428+00:00</complete_date>
            </checkListItem>
            <is_mark_delete>true</is_mark_delete>
          </ApiCompanyCustomDataCheckListItemPOST>
        </_custom_field_checklist_item>
      </ApiCompanyCustomDataPOST>
    </_fields>
  </customMasterFields>
</ApiCompany>