## List organizations the user has access to `client.Organizations.List(ctx, query) (*SinglePage[Organization], error)` **get** `/organizations` Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `query OrganizationListParams` - `ID param.Field[[]string]` Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value. - `Containing param.Field[OrganizationListParamsContaining]` - `Account string` Filter the list of organizations to the ones that contain this particular account. - `Organization string` Filter the list of organizations to the ones that contain this particular organization. - `User string` Filter the list of organizations to the ones that contain this particular user. IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization. - `Name param.Field[OrganizationListParamsName]` - `Contains string` (case-insensitive) Filter the list of organizations to where the name contains a particular string. - `EndsWith string` (case-insensitive) Filter the list of organizations to where the name ends with a particular string. - `StartsWith string` (case-insensitive) Filter the list of organizations to where the name starts with a particular string. - `PageSize param.Field[int64]` The amount of items to return. Defaults to 10. - `PageToken param.Field[string]` An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token. - `Parent param.Field[OrganizationListParamsParent]` - `ID OrganizationListParamsParentID` Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)." - `string` - `type OrganizationListParamsParentID string` Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)." - `const OrganizationListParamsParentIDNull OrganizationListParamsParentID = "null"` ### Returns - `type Organization struct{…}` References an Organization in the Cloudflare data model. - `ID string` - `CreateTime Time` - `Meta OrganizationMeta` - `Flags OrganizationMetaFlags` Enable features for Organizations. - `AccountCreation string` - `AccountDeletion string` - `AccountMigration string` - `AccountMobility string` - `SubOrgCreation string` - `ManagedBy string` - `Name string` - `Parent OrganizationParent` - `ID string` - `Name string` - `Profile AccountProfile` - `BusinessAddress string` - `BusinessEmail string` - `BusinessName string` - `BusinessPhone string` - `ExternalMetadata string` ### Example ```go package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/organizations" ) func main() { client := cloudflare.NewClient( option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) page, err := client.Organizations.List(context.TODO(), organizations.OrganizationListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } } ], "result_info": { "next_page_token": "next_page_token", "total_size": 0 }, "success": true } ```