Lists organizations the user is associated with.
/user/organizations
get
User's Organizations
user'-s-organizations-list-organizations
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "query",
"name": "name",
"schema": {
"description": "Organization name.",
"example": "Cloudflare, Inc.",
"maxLength": 100,
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 20,
"description": "Number of organizations per page.",
"maximum": 50,
"minimum": 5,
"type": "number"
}
},
{
"in": "query",
"name": "order",
"schema": {
"description": "Field to order organizations by.",
"enum": [
"id",
"name",
"status"
],
"example": "status",
"type": "string"
}
},
{
"in": "query",
"name": "direction",
"schema": {
"description": "Direction to order organizations.",
"enum": [
"asc",
"desc"
],
"example": "desc",
"type": "string"
}
},
{
"in": "query",
"name": "match",
"schema": {
"default": "all",
"description": "Whether to match all search requirements or at least one (any).",
"enum": [
"any",
"all"
],
"type": "string"
}
},
{
"in": "query",
"name": "status",
"schema": {
"description": "Whether the user is a member of the organization or has an inivitation pending.",
"enum": [
"member",
"invited"
],
"example": "member",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"name": {
"description": "Organization name.",
"example": "Cloudflare, Inc.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Access permissions for this User.",
"items": {
"example": "#zones:read",
"maxLength": 160,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"roles": {
"description": "List of roles that a user has within an organization.",
"items": {
"example": "All Privileges - Super Administrator",
"maxLength": 120,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"status": {
"description": "Whether the user is a member of the organization or has an inivitation pending.",
"enum": [
"member",
"invited"
],
"example": "member",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List Organizations response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"name": {
"description": "Organization name.",
"example": "Cloudflare, Inc.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Access permissions for this User.",
"items": {
"example": "#zones:read",
"maxLength": 160,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"roles": {
"description": "List of roles that a user has within an organization.",
"items": {
"example": "All Privileges - Super Administrator",
"maxLength": 120,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"status": {
"description": "Whether the user is a member of the organization or has an inivitation pending.",
"enum": [
"member",
"invited"
],
"example": "member",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List Organizations response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]