Skip to content
On this page

/company/{companyId}

Retrieves the company with the given ID.

HTTP Request

GET https://api.q2open.io/v1/company/{companyId}

Arguments

ParameterDescription
companyIdID of company to retrieve.

Returns

Returns a company object if a valid companyId was provided. Returns an error otherwise.

Example Request

shell
curl "https://api.q2open.io/v1/company/566595c8ce88ccec69328566" \
  -H "Authorization: Bearer dc220490-e6ee-11e5-8a94-e7385a8d929e" \
  -G

Example Response

json
{
  "_id": "579b695decea110719b1874d",
  "name": "Netflix",
  "categories": ["streaming"],
  "status": "operational",
  "logo": {
    "url": "https://s3.amazonaws.com/app-assets.unbill.io-primary/uploads/utility-provider-logos/7242937ba29042cce61a8e4745269fce.png",
    "background": false,
    "svg": {
      "url": "https://s3.amazonaws.com/app-assets.unbill.io-primary/uploads/utility-provider-logos/7242937ba29042cce61a8e4745269fce.svg",
      "color": "FF041F"
    }
  },
  "requiredPayment": "bank",
  "schedule": "on-due-date",
  "auth": {
    "urls": {
      "login": "https://www.netflix.com/Login",
      "signup": "https://www.netflix.com"
    },
    "loginFields": [{
      "placeholder": "Username",
      "formType": "text",
      "name": "username",
      "label": "Username"
    }, {
      "placeholder": "Password",
      "formType": "password",
      "name": "password",
      "label": "Password"
    }]
  },
  "geo": {
    "lat": 30.70,
    "lng": -95.53,
    "state_short": "TX",
    "state_long": "Texas",
    "zipcode": "77340"
  }
}