☰
Navigation :

GET /companies

Fetches the information Invisible Collector knows about the company.

Since the authorization token will be associated with a company account no additional information is required.

    curl -XGET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer 4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739" \
  https://api.invisiblecollector.com/companies

    require 'invisible_collector'

client = InvisibleCollector::API.new(api_token: '4a415cc660e67d8f4d26d5a7f390183a86fc3a4524ded78dc2448e86c48b2739')
client.company.get()

    import com.ic.invisiblecollector.IcApiFacade;
import com.ic.invisiblecollector.model.Company;

IcApiFacade apiFacade = new IcApiFacade("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");
Company company = apiFacade.requestCompanyInfo();

    using InvisibleCollectorLib;
using InvisibleCollectorLib.Model;

var ic = new InvisibleCollector("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");
Company company = await ic.GetCompanyInfoAsync();

    This request will return JSON. Example return:

    {
  "name": "Johny's Company",
  "vatNumber": "PT543219876",
  "address": "Invisible Avenue, 456",
  "zipCode": "1234-543",
  "city": "Lisbon",
  "country": "PT",
  "gid": "061d2feb-81c2-4694-a74a-13cecbe7d2ce",
  "notificationsEnabled": true
}

    Endpoint

    GET https://api.invisiblecollector.com/companies

    Response body

    Attribute Type Description
    name string The name of the company
    vatNumber string The company’s unique identification number for tax purposes
    address string The company’s address
    zipCode string The company’s zip code
    city string The company’s city
    country string The company’s ISO 3166-1 country code
    gid string An unique identifier of this company within Invisible Collector’s system
    notificationsEnabled boolean Flag that indicates if Invisible Collector is sending notifications to customers

    Errors

    This endpoint may return the following errors

    HTTP Code Description
    401 Unauthorized Invalid credentials were supplied