GET
/
api
/
v2
/
public
/
linked-account
curl --request GET \
  --url https://api.gocobalt.io/api/v2/public/linked-account \
  --header 'x-api-key: <api-key>'
{
    "docs": [
      {
          "associated_org": "63dba3b4d9c4be8f0f3f5e8f",
          "account_id": "1234567893",
          "environment": "test",
          "name": "Charizard8",
      }
    ],
    "totalDocs": 1,
    "limit": 10,
    "totalPages": 1,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": false,
    "prevPage": null,
    "nextPage": null
}

This API retrieves a list of all linked accounts present in your account.

​
Request description

​
Query Parameters

​
page
integer
default:"1"

Page number eg: 5

​
limit
integer
default:"10"

Records per page eg: 10

​
Response description

​
docs
array
​
associated_org
string

Organization Id

​
account_id
string

Linked account id

​
environment
string

Environment in which the account was created

​
name
string

Name of the linked account

​
totalDocs
integer

Total number of existing linked accounts

​
limit
integer

Records per page

​
page
integer

Current Page

​
pagingCounter
integer

Total number of existing linked accounts

​
hasPrevPage
boolean

If the current Page has any previous page

​
hasNextPage
boolean

If the current Page has any next page

​
prevPage
integer

Previous page number

​
nextPage
integer

Next page number

{
    "docs": [
      {
          "associated_org": "63dba3b4d9c4be8f0f3f5e8f",
          "account_id": "1234567893",
          "environment": "test",
          "name": "Charizard8",
      }
    ],
    "totalDocs": 1,
    "limit": 10,
    "totalPages": 1,
    "page": 1,
    "pagingCounter": 1,
    "hasPrevPage": false,
    "hasNextPage": false,
    "prevPage": null,
    "nextPage": null
}