GET /organizations
Retrieve a list of organizations a particular user has access to.
Servers
- https://api.cloudflare.com/client/v4
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id[] |
Array | No |
Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value. |
parent.id |
No |
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)." |
|
name |
String | No |
(case-sensitive) Filter the list of organizations to where the name is equal to a particular string. |
containing.account |
String | No |
Filter the list of organizations to the ones that contain this particular account. |
name.contains |
String | No |
(case-insensitive) Filter the list of organizations to where the name contains a particular string. |
page_size |
Integer | No |
The amount of items to return. Defaults to 10. |
containing.user |
String | No |
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. |
containing.organization |
String | No |
Filter the list of organizations to the ones that contain this particular organization. |
name.startsWith |
String | No |
(case-insensitive) Filter the list of organizations to where the name starts with a particular string. |
name.endsWith |
String | No |
(case-insensitive) Filter the list of organizations to where the name ends with a particular string. |
page_token |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.