In this article, you can read about how to retrieve company data via the API — listing and searching companies, downloading a company file, and retrieving company contacts, including the full field references for each.
Get Company
GET
https://api.recman.io/v2/get/?key={{api_key}}
&scope=company&fields=name,visitAddress,tags&userId=13236&page=1Retrieving data about companies is done through the GET method.
Search parameters
There are multiple ways you can fetch data about companies. You can use one of the search parameters below, and combine different parameters to adjust your fetch requests more precisely:
- page — page number, 500 companies per page
- companyId — search for a specific company ID
- companyIds — search for several company IDs
- departmentId — retrieve companies that are only connected to a specific department
- userId — retrieve companies that are only connected to a specific co-worker (user) ID
- updated — retrieve companies updated later than or equal to a specified date/time
(e.g.2024-01-01 00:00:00)
Company Fields
| Fields | Description |
|---|---|
| companyId integer | Company ID. Required on operation: update, delete |
| parentCompanyId integer | Parent company ID |
| name string | Name. Required on operation: insert |
| number string | Company number (if not defined, the system automatically generates one) |
| dunsId integer | D-U-N-S Number — a unique nine-digit business identifier |
| vatNumber integer | VAT number |
| email string | |
| web string | Web |
| officePhone string | Office phone |
| invoiceEmail string | Invoice email |
| newsletter boolean | No = 0, Yes = 1. Valid values: 0, 1 |
| linkedin / facebook / twitter string | Social profile links |
| employeeCount integer | Employee count |
| branchCategoryId integer | Branch category ID |
| description string | Description |
| notes string | Notes |
| invoiceNotes string | Invoice notes |
| creditTime integer | Credit time |
| created date-time | Created. Format: Y-m-d H:i:s |
| updated date-time | Updated. Format: Y-m-d H:i:s |
| departmentIds array of integer | Array of department IDs |
| userIds array of integer | Array of user (co-worker) IDs |
| directions string | Directions |
| invoiceSendMethod string | Valid values: emailWithTrackingLink, emailWithAttachment, print, ehf |
| invoiceInterval string | Invoice interval |
| invoiceFactor integer | The invoice factor from a company, if added. GET only |
| creditRating string | Credit rating |
| approvedCreditLimit string | Approved credit limit |
| recommendedCreditLimit string | Recommended credit limit |
| type string | Valid values: customer, collaborator, supplier, prospect, suspect, competitor, freelance, terminated, ownCompany, notApplicable, formerCustomer, others, lostCustomer, subcontractor |
| projectData array of strings | Info of the project data on a company card. GET only. See Insert/Delete Company - projectData in the other Companies articles |
| salaryMatrixCategory array of objects | Info of the company salary matrix categories. GET only |
| addresses (visitAddress, postAddress, invoiceAddress, deliveryAddress) object(s) | Nested address objects — see the Creating Companies article |
| attributes object | Nested attribute object — see the Creating Companies article |
| file object | Nested file object — see the Creating Companies article |
| eInvoice object | Nested eInvoice object — see the Creating Companies article |
PARAMS
| key | {{api_key}} required |
| scope | company required |
| fields | name, visitAddress, tags required, at least 1 field, comma-separated |
| userId | 13236 required |
| page | 1 optional |
Note
You can also look up a company directly by adding companyId as a parameter, for example fetching fields such as name, number, email, officePhone, invoiceAddress, attributes, file, eInvoice, salaryMatrixCategory and tags.
Get Company File
GET
https://api.recman.io/v2/get/?key={{api_key}}
&scope=companyFile&companyId=2355&fileId=3534674Retrieving data about a company file is done through the GET method. The response returns the file's fileId, base64 content, extension, and name.
Company File Fields
| Fields | Description |
|---|---|
| companyId integer | Company ID. Required |
| fileId integer | File ID. Required |
PARAMS
| key | {{api_key}} required |
| scope | companyFile required |
| companyId | 2355 required |
| fileId | 3534674 required |
Get Company Contact
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=
companyContact&fields=name,email,attributes&companyId=1055074Retrieving data about company contacts is done through the GET method.
Company Contact Fields
| Fields | Description |
|---|---|
| companyContactId string | Company Contact ID. Required on operation: update, delete |
| companyId integer | Company ID. Required on operation: insert |
| name string | Name |
| email string | |
| departmentId integer | Department ID |
| mobilePhone / officePhone / homePhone string | Phone numbers |
| notes string | Notes |
| newsletter boolean | No = 0, Yes = 1. Valid values: 0, 1 |
| active boolean | No = 0, Yes = 1. Valid values: 0, 1 |
| twitter / linkedin / facebook string | Social profile links |
| updated / created date-time | Format: Y-m-d H:i:s |
| profilePicture string | Profile picture |
| attributes object | Nested attributes object — see the Creating Companies article |
| userIds array of integer | List of responsible users |
Company Contact Attribute Fields
attributes – object
Sub Fields
| Sub Fields | Description |
|---|---|
| attributeId integer | The ID of attribute. Required on operation: insert |
| companyContactAttributeId integer | The ID of the inserted attribute. Required on operation: update, delete |
| rating integer | Valid values: 1, 2, 3, 4, 5 |
| bool string | 0 = False, 1 = True. Valid values: 0, 1 |
| text string | Text, limited to 255 characters |
| dropdownId integer | The ID of the dropdown value |
| checkboxIds array of integer | Array of checked checkbox IDs |
PARAMS
| key | {{api_key}} required |
| scope | companyContact required |
| fields | name, email, attributes required, at least 1 field, comma-separated |
| companyId | 1055074 required |
What's next
Continue with Companies: Creating Companies, Addresses, Files, Attributes, eInvoice, and Contacts via the API to insert a company and attach nested data, or Companies: Updating and Deleting Companies, Contacts, and Project Data via the API to modify or remove existing data.