Skip to main content
GET
/
auth
/
companies
cURL
curl --request GET \
  --url https://api.maesn.dev/auth/companies \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'
{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "totalPages": 123
    }
  },
  "data": [
    {
      "id": "string",
      "client_number": "1",
      "consultant_number": "223344",
      "environmentId": "string",
      "name": "string",
      "subscription": [
        {
          "id": "ACCOUNTING",
          "active": true,
          "name": "Accounting",
          "status": "paying"
        }
      ]
    }
  ]
}

System-specific requirements

Please ensure the query parameter environmentName is accurately filled with the respective environment to which the company belongs. You can obtain this value by using the GET Environments endpoints available under the Authentication section.
Supported Response Parameters:
id
string
name
string
environmentId
string
Supported Response Parameters:
id
string
name
string
client_number
number
consultant_number
number
subscription
Subscription
Supported Response Parameters:
id
string
name
string
client_number
number
consultant_number
number
subscription
Subscription
Supported Response Parameters:
id
string
name
string
Supported Response Parameters:
id
string
name
string
This endpoint retrieves the subscriptions available for the user.
Supported Response Parameters:
id
string
name
string
subscription
Subscription[]
This endpoint retrieves both the company ID and environment ID, so there is no need to call the ‘Get Environments’ endpoint separately. Ensure both values are included when making subsequent API requests.
Supported Response Parameters:
id
string
name
string
environmentId
string
Supported Response Parameters:
id
string
name
string

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Query Parameters

environmentName
string

Response

200 - application/json
meta
object
data
object[]
I