Retrieve details of accounts

GET https://{controlplane_path}api/1/rest/public/catalog/{env_org}/accounts           
Retrieves list of accounts in the environment.

Prerequisites

  • Environment (Org) admin permissions

Path parameters

Parameter Description Required
controlplane_path The path to the SnapLogic control plane: elastic.snaplogic.com
For the UAT or EMEA control plane, substitute the name for elastic. For example:
  • uat.elastic.snaplogic.com
  • emea.snaplogic.com
Yes
env_org The name of the SnapLogic Environment/Org. Yes

Query parameters

None

Request header

In the request header, specify Basic for authorization, add your credentials (Login and password of your SnapLogic user or service account), and specify application/json for content type. For more details on accounts refer to Manage accounts.


Authorization: Basic {base64_encoded <email>:<password>}
Content-Type: application/json
          

Example of Basic authentication using Postman

When using JWT authentication, the API requests includes specific headers. In the request header, specify Bearer Token for authorization, add the token, and specify application/json for content type. These headers are automatically added when you configure bearer token authentication in your API client. The authorization header contains the word Bearer followed by a space and your JWT token.


Authorization: Bearer Token {token}
Content-Type: application/json
          

Example of JWT authenthication using Postman

Response

A successful response includes a Code 200 OK where:
  • list: The list of accounts.
  • page: The current page of results.
  • content: Each JSON object contains the account.
 {
 "size": 0,
 "page": 0,
 "total_pages": 0,
 "total_elements": 0,
 "sync_status": "",
 "content": [
 json1, json2, json3
 ]
}

Example

Assuming a request for a development environment on the elastic control plane:

 {
 "size": 2,
 "page": 0,
 "total_pages": 1,
 "total_elements": 2,
 "sync_status": "finished",
 "content": [
  {
  "id": "f0ad0881-00a8-48da-b758-44dcb332f7b1_1",
  "name": "Test slack",
  "path": "/DEV/DEMO/shared/Testslack",
  "class_label": "Slack Generic OAuth2 Bot Token Account",
  "created_by": "[email protected]",
  "updated_at": "2025-04-17T03:49:36.760Z",
  "created_at": "2025-04-17T03:32:46.802Z",
  "pipelines_count": 1
  },
  {
  "id": "bae63ce7-32c5-4e6f-9a89-ffbbae614831_1",
  "name": "Acc Google BigQuery",
  "path": "/DEV/Automation/vizv/Acc Google BigQuery",
  "class_label": "Google Service Account JSON",
  "created_by": "[email protected]",
  "updated_at": "2024-06-04T14:52:30.496Z",
  "created_at": "2024-06-04T14:52:19.351Z",
  "pipelines_count": 1
  },