COconekta
Companies

Get List of Companies

Changed on

Consume the list of child companies. This is used for holding companies with several child entities.

get/companies

Request

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Response

successful

has_moreboolean required

Indicates if there are more pages to be requested

objectstring required

Object type, in this case is list

next_page_urlstring nullable

URL of the next page.

previous_page_urlstring nullable

Url of the previous page.

Example response

{
  "object": "list",
  "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
  "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
  "data": [
    {
      "id": "6827305a1ec60400015eb116",
      "name": "test",
      "account_status": "signed_up",
      "card_payments_enabled": true,
      "parent_company_id": "680bf1da38716d00013543bc",
      "onboarding_status": "pending",
      "documents": [
        {
          "file_classification": "deposit_account_cover",
          "status": "pending"
        }
      ],
      "created_at": 1748968241,
      "object": "company",
      "three_ds_enabled": true,
      "three_ds_mode": "strict",
      "onboarding_url": "https://onboarding.conekta.com/resume/6827305a1ec60400015eb116"
    }
  ]
}

Changes

  • 52f4c0dd8a1bRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status