ManagementAccountAccount company level

Get a list of company accounts

GET
/companies

Returns the list of company accounts that your API credential has access to. The list is grouped into pages as defined by the query parameters.

To make this request, your API credential must have the following roles:

  • Management API—Account read

Authorization

AuthorizationBasic <token>

In: header

Query Parameters

pageNumber?integer

The number of the page to fetch.

Formatint32
pageSize?integer

The number of items to have on a page, maximum 100. The default is 10 items on a page.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies"

Example response when your API credential has access to one company account.

{  "_links": {    "first": {      "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"    },    "last": {      "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"    },    "self": {      "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"    }  },  "itemsTotal": 1,  "pagesTotal": 1,  "data": [    {      "id": "YOUR_COMPANY_ACCOUNT",      "name": "YOUR_COMPANY_NAME",      "status": "Active",      "dataCenters": [        {          "name": "default",          "livePrefix": ""        }      ],      "_links": {        "self": {          "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"        },        "apiCredentials": {          "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"        },        "users": {          "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"        },        "webhooks": {          "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"        }      }    }  ]}