API Reference

Get Companies

Get a list of each company's details.
Companies allow you to create user groups within a team. For example, to allow a contracted dispatcher to oversee their drivers in the Bringg Platform, yet prevent their access to your organization's information.
Also known as Get All Companies.

QUERY PARAMS

{
}

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

id

Int32

Bringg's unique ID of the company.

merchant_id

Int32

Bringg’s ID for the merchant.

name

string

The name of the company.

external_id

string

Your ID for the company.

phone

string

The company's phone number.

tax_id

string

The company's tax ID.

address

string

The company's address in a single line.

lat

Int32

The lat coordinate of the company's location.

lng

Int32

The lng coordinate of the company's location.

zipcode

string

The zip code of the company's location.

city

string

The city of the company's location.

street

string

The street of the company's location.

house_number

string

The house number of the company's location.

Responses

{
    "success": true,
    "companies": [
         {
            "id": 540,
            "merchant_id": 1,
            "name": "fast delivery inc",
            "external_id": "123123",
            "phone": null,
            "tax_id": null,
            "address": "3613 Old Vernon Ct, Old Vernon Court, Alexandria, VA, USA",
            "lat": 38.730437,
            "lng": -77.096005,
            "zipcode": "22309",
            "city": "Alexandria",
            "street": "Old Vernon Court",
            "house_number": 3613
        },
        {
            "id": 5,
            "merchant_id": 1,
            "name": "best delivery corp",
            "external_id": "384923",
            "phone": null,
            "tax_id": null,
            "address": null,
            "lat": null,
            "lng": null,
            "zipcode": null,
            "city": null,
            "street": null,
            "house_number": null
        }
    ]
}