Get company

api-docs Redoc document (api spec)

Retrieve company detail by id or name

get

Required scopes

This endpoint requires the following scopes:

Authorizations

api_key

AuthorizationstringRequired

Path parameters

id_or_namestringRequired

Company name spaces will be separated with '_' character, FE 'Green earth blockchain' will be 'Green_earth_blockchain'

Responses

200

Success

application/json

get

/api/company/{id_or_name}

HTTPcURLJavaScriptPython

GET /api/company/{id_or_name} HTTP/1.1
Host: url to be defined
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "error": {
    "code": "040",
    "message": "Wrong email or password"
  },
  "data": {
    "company": {
      "company_constants": {
        "geis": 1
      },
      "_id": "text",
      "company_name": "text"
    }
  }
}

The "/api/company/{id_or_name}" endpoint is used to retrieve details about a specific company by its id or name. It requires an API key with either "partner" or "admin" privileges. The company name is passed as a path parameter "id_or_name" with spaces separated by '_' characters, for example, "Green earth blockchain" would be represented as "Green_earth_blockchain".

The endpoint returns a JSON response with a 200 status code in case of success. The response body contains an "error" object with properties "code" and "message" that describes the error in case of failure. The "data" property contains the company details, including "company_constants", "id", and "company_name". The "company_constants" property has a "geis" property that is a number.