Return a list of organizations.

External Documentation

To learn more, visit the Terraform Cloud documentation.

​
Basic Parameters

ParameterDescription
QueryA search query string. Organizations are searchable by name and notification email. When used, Query By Email and Query By Notification Name parameters aren’t available.
Query By NameA search query string. This query searches organizations by name. If used with Query By Notification Email, it returns organizations that match both queries. Can’t be used with the Query parameter.
Query By Notification EmailA search query string. This query searches organizations by notification email. If used with Query By Name, it returns organizations that match both queries. Can’t be used with the Query parameter.

​
Advanced Parameters

ParameterDescription
Page NumberPage number of results to retrieve. Defaults to the first page, if omitted when Page Size is provided.
Page SizeNumber of results per page. Valid range is 1-100. Defaults to 20 if omitted when Page Number is provided.

​
Example Output

{
	"data": [
		{
			"id": "hashicorp",
			"type": "organizations",
			"attributes": {
				"external-id": "org-Hysjx5eUviuKVCJY",
				"created-at": "2021-08-24T23:10:04.675Z",
				"email": "hashicorp@example.com",
				"session-timeout": null,
				"session-remember": null,
				"collaborator-auth-policy": "password",
				"plan-expired": false,
				"plan-expires-at": null,
				"plan-is-trial": false,
				"plan-is-enterprise": false,
				"plan-identifier": "developer",
				"cost-estimation-enabled": true,
				"send-passing-statuses-for-untriggered-speculative-plans": true,
				"aggregated-commit-status-enabled": false,
				"allow-force-delete-workspaces": true,
				"name": "hashicorp",
				"permissions": {
					"can-update": true,
					"can-destroy": true,
					"can-access-via-teams": true,
					"can-create-module": true,
					"can-create-team": true,
					"can-create-workspace": true,
					"can-manage-users": true,
					"can-manage-subscription": true,
					"can-manage-sso": true,
					"can-update-oauth": true,
					"can-update-sentinel": true,
					"can-update-ssh-keys": true,
					"can-update-api-token": true,
					"can-traverse": true,
					"can-start-trial": true,
					"can-update-agent-pools": true,
					"can-manage-tags": true,
					"can-manage-varsets": true,
					"can-read-varsets": true,
					"can-manage-public-providers": true,
					"can-create-provider": true,
					"can-manage-public-modules": true,
					"can-manage-custom-providers": false,
					"can-manage-run-tasks": false,
					"can-read-run-tasks": false,
					"can-create-project": true
				},
				"fair-run-queuing-enabled": true,
				"saml-enabled": false,
				"owners-team-saml-role-id": null,
				"two-factor-conformant": false,
				"assessments-enforced": false,
				"default-execution-mode": "remote"
			},
			"relationships": {
				"default-agent-pool": {
					"data": null
				},
				"oauth-tokens": {
					"links": {
						"related": "/api/v2/organizations/hashicorp/oauth-tokens"
					}
				},
				"authentication-token": {
					"links": {
						"related": "/api/v2/organizations/hashicorp/authentication-token"
					}
				},
				"entitlement-set": {
					"data": {
						"id": "org-Hysjx5eUviuKVCJY",
						"type": "entitlement-sets"
					},
					"links": {
						"related": "/api/v2/organizations/hashicorp/entitlement-set"
					}
				},
				"subscription": {
					"links": {
						"related": "/api/v2/organizations/hashicorp/subscription"
					}
				}
			},
			"links": {
				"self": "/api/v2/organizations/hashicorp"
			}
		},
		{
			"id": "hashicorp-two",
			"type": "organizations",
			"attributes": {
				"external-id": "org-iJ5tr4WgB4WpA1hD",
				"created-at": "2022-01-04T18:57:16.036Z",
				"email": "hashicorp@example.com",
				"session-timeout": null,
				"session-remember": null,
				"collaborator-auth-policy": "password",
				"plan-expired": false,
				"plan-expires-at": null,
				"plan-is-trial": false,
				"plan-is-enterprise": false,
				"plan-identifier": "free",
				"cost-estimation-enabled": false,
				"send-passing-statuses-for-untriggered-speculative-plans": false,
				"aggregated-commit-status-enabled": true,
				"allow-force-delete-workspaces": false,
				"name": "hashicorp-two",
				"permissions": {
					"can-update": true,
					"can-destroy": true,
					"can-access-via-teams": true,
					"can-create-module": true,
					"can-create-team": false,
					"can-create-workspace": true,
					"can-manage-users": true,
					"can-manage-subscription": true,
					"can-manage-sso": false,
					"can-update-oauth": true,
					"can-update-sentinel": false,
					"can-update-ssh-keys": true,
					"can-update-api-token": true,
					"can-traverse": true,
					"can-start-trial": true,
					"can-update-agent-pools": false,
					"can-manage-tags": true,
					"can-manage-varsets": true,
					"can-read-varsets": true,
					"can-manage-public-providers": true,
					"can-create-provider": true,
					"can-manage-public-modules": true,
					"can-manage-custom-providers": false,
					"can-manage-run-tasks": false,
					"can-read-run-tasks": false,
					"can-create-project": false
				},
				"fair-run-queuing-enabled": true,
				"saml-enabled": false,
				"owners-team-saml-role-id": null,
				"two-factor-conformant": false,
				"assessments-enforced": false,
				"default-execution-mode": "remote"
			},
			"relationships": {
				"default-agent-pool": {
					"data": null
				},
				"oauth-tokens": {
					"links": {
						"related": "/api/v2/organizations/hashicorp-two/oauth-tokens"
					}
				},
				"authentication-token": {
					"links": {
						"related": "/api/v2/organizations/hashicorp-two/authentication-token"
					}
				},
				"entitlement-set": {
					"data": {
						"id": "org-iJ5tr4WgB4WpA1hD",
						"type": "entitlement-sets"
					},
					"links": {
						"related": "/api/v2/organizations/hashicorp-two/entitlement-set"
					}
				},
				"subscription": {
					"links": {
						"related": "/api/v2/organizations/hashicorp-two/subscription"
					}
				}
			},
			"links": {
				"self": "/api/v2/organizations/hashicorp-two"
			}
		}
	],
	"links": {
		"self": "https://tfe-zone-b0c8608c.ngrok.io/api/v2/organizations?page%5Bnumber%5D=1&page%5Bsize%5D=20",
		"first": "https://tfe-zone-b0c8608c.ngrok.io/api/v2/organizations?page%5Bnumber%5D=1&page%5Bsize%5D=20",
		"prev": null,
		"next": null,
		"last": "https://tfe-zone-b0c8608c.ngrok.io/api/v2/organizations?page%5Bnumber%5D=1&page%5Bsize%5D=20"
	},
	"meta": {
		"pagination": {
			"current-page": 1,
			"page-size": 20,
			"prev-page": null,
			"next-page": null,
			"total-pages": 1,
			"total-count": 2
		}
	}
}

​
Workflow Library Example

List Organizations with Terraform Cloud and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?