Orgs Meta

Get aggregated org metadata

get

Retrieves a unified view of all Salesforce organizations from multiple sources: registered orgs, scratch org pools, and sandbox pools. Orgs appearing in multiple sources are deduplicated and merged into a single entry.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

poolTagstringOptional

Filter pool orgs by pool tag

Example: core_dev

statusstringOptional

Filter pool orgs by status

Example: available

repositoryIdentifierstringOptional

Filter by repository identifier (owner/repo format)

Example: flxbl-io/sf-core

includeEnvironmentsbooleanOptional

Include environment details for registered orgs

Default: trueExample: true

devHubOnlybooleanOptional

Filter registered orgs to DevHubs only

Default: falseExample: false

Responses

200

Aggregated org metadata retrieved successfully

application/json

namestringRequired

Common identifier - instanceName for sandboxes, username for production/scratch orgs

usernamestringOptional

Salesforce username (email format)

instanceUrlstringOptional

Salesforce instance URL

orgIdstringOptional

Salesforce organization ID (18 character)

loginUrlstringOptional

Login URL for authentication

organizationTypestring · enumOptional

Organization type (only for registered orgs)

Possible values:

isDevHubbooleanOptional

Whether this org is a DevHub (only for registered orgs)

isDefaultbooleanOptional

Whether this is the default org (only for registered orgs)

metadataobjectOptional

Custom metadata attached to the registered org

401

Unauthorized - invalid or missing authentication token

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/orgs/meta

HTTPcURLJavaScriptPython

GET /sfp/api/orgs/meta HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "username": "text",
    "sources": [
      "registered",
      "scratch_org_pool"
    ],
    "instanceUrl": "text",
    "orgId": "text",
    "loginUrl": "text",
    "organizationType": "production",
    "isDevHub": true,
    "isDefault": true,
    "metadata": {},
    "environment": {
      "id": "text",
      "name": "text",
      "repositoryIdentifier": "text",
      "category": "dev",
      "branch": "text",
      "isActive": true
    },
    "poolInfo": {
      "poolTag": "text",
      "repositoryIdentifier": "text",
      "status": "available",
      "assignedToUserEmail": "text",
      "devHubUsername": "text",
      "expiresAt": "text"
    }
  }
]