List Companies

List companies.

Use the returned companyId when synchronizing contacts or company price-list assignments.

Behaviour

Optionally filter by status or by a case-insensitive search over the company name.

Results are cursor-paginated.

Requires the companies:read scope.

get

Authorizations

AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Query parameters

limitinteger · min: 1 · max: 5000OptionalDefault: 50

cursorstring · min: 1Optional

statusstring · enumOptionalPossible values:

searchstring · min: 1Optional

Responses

200

Successful response.

application/json

400

Invalid request data.

application/json

401

Missing or invalid API key.

application/json

403

The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).

application/json

429

The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.

application/json

500

Internal server error.

application/json

get/v1/companies

GET /v1/companies HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "companyId": "COMP-123e4567-e89b-12d3-a456-426614174000",
      "companyNumericId": 1,
      "companyName": "text",
      "address": {
        "street": "text",
        "city": "text",
        "postcode": "text",
        "country": "text"
      },
      "email": "text",
      "workNumber": "text",
      "currency": "text",
      "status": "ACTIVE",
      "accountManagerId": "text",
      "createdAt": "text",
      "modifiedAt": "text"
    }
  ],
  "page": {
    "limit": 1,
    "nextCursor": "text"
  }
}