Applies to integrated customers using the RecoveryConnect API
Retrieve Company Details
Description: This endpoint retrieves the details of a specific company.
By providing the company ID, this endpoint returns company-related information including company identification details and associated metadata. Optional query parameters can be used to filter related address records based on mapped iRepo lot IDs or branch IDs.
URL: /api/v150/companies/{company_id}
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
irepo_lot_id | Filters address records by the mapped iRepo lot identifier | No | ?irepo_lot_id=123 |
irepo_branch_id | Filters address records by the mapped iRepo branch identifier
| No | ?irepo_branch_id=456 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/companies/130875 |
Request Body: NA
Response:
{ "data": { "id": 130875, "name": "Swift Recovery Demo", "type": 4, "updated_at": "2025-09-01 08:31:26", "addresses": [ { "id": 131461, "address_id": 2121206, "company_id": 130875, "is_primary": 1, "is_cars_certified": 1, "is_risc_certified": 1, "risc_lot_expiration": "2024-03-15", "risc_inspection_id": "test33", "risc_certification_date": "2023-01-13", "irepo_lot_id": null, "irepo_branch_id": null, "address_details": { "id": 2121206, "name": "Main", "address_1": "453 Brandyn Vista", "address_2": "", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85029", "county_name": "Maricopa", "longitude": "-112.11493800", "latitude": "33.58439400", "unit": null, "phones": [] } }, { "id": 132026, "address_id": 2193531, "company_id": 130875, "is_primary": 0, "is_cars_certified": 1, "is_risc_certified": 0, "risc_lot_expiration": null, "risc_inspection_id": null, "risc_certification_date": null, "irepo_lot_id": null, "irepo_branch_id": null, "address_details": { "id": 2193531, "name": "Jacksonville Branch", "address_1": "678 Pink Flat", "address_2": "", "state_abbr": "FL", "city_name": "Saint Johns", "zip_code": "32259", "county_name": "Saint Johns", "longitude": "-81.55824400", "latitude": "30.08803100", "unit": null, "phones": [ { "id": 919289, "type": 2, "number": "829-117-6658", "extension": null }, { "id": 919290, "type": 4, "number": "209-763-6075", "extension": null }, { "id": 919291, "type": 3, "number": "854-570-3836", "extension": null } ] } }, { "id": 149106, "address_id": 2931133, "company_id": 130875, "is_primary": 0, "is_cars_certified": 1, "is_risc_certified": 1, "risc_lot_expiration": "2023-01-13", "risc_inspection_id": "TEST DATA", "risc_certification_date": "2022-09-29", "irepo_lot_id": null, "irepo_branch_id": null, "address_details": { "id": 2931133, "name": "tampa location", "address_1": "236 Schneider Centers Suite 043", "address_2": "", "state_abbr": "FL", "city_name": "Tampa", "zip_code": "33602", "county_name": "Hillsborough", "longitude": "-82.45454300", "latitude": "27.95471700", "unit": null, "phones": [ { "id": 1154890, "type": 2, "number": "", "extension": null }, { "id": 1154891, "type": 4, "number": "", "extension": null }, { "id": 1154892, "type": 3, "number": "", "extension": null } ] } } ] } } |
List Company Connections
Description: This endpoint retrieves the list of entities connected with the authenticated user's company.
Company connections represent external entities associated with the company, such as vendors, lenders, forwarders, or other operational partners. The endpoint supports multiple filters to narrow down the results based on company type, category, location, or iRepo identifiers.
Pagination parameters can be used to control the number of records returned per request.
URL: /api/v150/company/connections
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
type | Filters results based on the company type ID | No | ?type=2 |
per_page | Number of records returned per page. Default is 250, maximum allowed is 5000 | No | ?per_page=500 |
page | Specifies the page number of the results to retrieve | No | ?page=1 |
category | Filters results by company category such as Vendor, Lender, or Forwarder | No | ?category=Vendor |
address | Filters results where address_1 contains the specified string | No | ?address=Main |
zip | Filters results by ZIP or postal code | No | ?zip=85001 |
city | Filters results by city name | No | ?city=Phoenix |
county | Filters results by county name | No | ?county=Maricopa |
irepo_lot_id | Filters address records by the mapped iRepo lot identifier | No | ?irepo_lot_id=123 |
irepo_branch_id | Filters address records by the mapped iRepo branch identifier
| No | ?irepo_branch_id=456 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/company/connections?type=3&zip=92120 |
Request Body: NA
Response:
{ "data": [ { "id": 10002, "name": "Limited User Version Demo", "type": 3, "updated_at": "2024-03-19 10:20:17", "addresses": [ { "id": 2, "address_id": 2, "company_id": 10002, "is_primary": 1, "is_cars_certified": 1, "is_risc_certified": 1, "risc_lot_expiration": "2025-01-03", "risc_inspection_id": "1234", "risc_certification_date": "2023-01-13", "irepo_lot_id": null, "irepo_branch_id": null, "address_details": { "id": 2, "name": null, "address_1": "1222 N Main Ave", "address_2": "", "state_abbr": "CA", "city_name": "San Diego", "zip_code": "92120", "county_name": "San Diego", "longitude": null, "latitude": null, "unit": null, "phones": [ { "id": 2, "type": 2, "number": "111-111-1111", "extension": null }, { "id": 10, "type": 3, "number": "333-333-3333", "extension": null }, { "id": 18, "type": 4, "number": "222-222-2222", "extension": null } ] } } ] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/company/connections?type=3&zip=92120&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/company/connections?type=3&zip=92120&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/company/connections", "per_page": 250, "to": 1, "total": 1 } } |
List Company Users (Employees)
Description: This endpoint retrieves the list of users (employees) associated with the authenticated user's company.
The endpoint returns user records linked to the company, including employee details and associated metadata. Pagination parameters can be used to control the number of records returned per request.
URL: /api/v150/employees
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
per_page | Number of records returned per page. Default is 250, maximum allowed is 5000 | No | ?per_page=500 |
page | Specifies the page number of the results to retrieve | No | ?page=1 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/employees?per_page=1 |
Request Body: NA
Response:
{ "data": [ { "id": 11765, "company_id": 10004, "name": "Forwarding Office", "firstname": "Forwarding", "lastname": "Office", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Administrator FWD", "API Connection", "Accountant", "Case Worker FWD", "Compliance Officer FWD ", "Field Agent", "Remarketing FWD", "Team Lead", "Transportation FWD", "Accountant", "Administrator FWD", "Field Agent" ], "self": "http://stg-api.mbsisystems.com/api/employees/11765", "expand": "employee" } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/employees?page=1", "last": "http://stg-api.mbsisystems.com/api/v140/employees?page=732", "prev": null, "next": "http://stg-api.mbsisystems.com/api/v140/employees?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 732, "path": "http://stg-api.mbsisystems.com/api/v140/employees", "per_page": 1, "to": 1, "total": 732 } } |