Olery Developer Portal logo Olery Developer Portal

Method Path
GET https://agora.olery.com/v2/companies

This route can be used to retrieve basic company information for all companies you have access to.

Output Format

The data is returned as an array of JSON objects in the data key. Each object in this array has the following fields:

Field Data Types Description
id Fixnum The ID of the company.
name String The name of the company.

When a client doesn’t have access to any companies the data key will contain an empty array.

Example Output

    {
        "data": [
            {
                "id": 10,
                "name": "Foobar Foo"
            },
            {
                "id": 11,
                "name": "Foobar Bar"
            }
        ]
    }

Response Statuses

Status Code Reason
200 OK

Response Fields

Field Data Types Description
data Array The list of company objects.