Back to top

Organizations

Organizations Management

Retrieve all organizations
GET
/organizations

Returns a list of organizations that are accessible to the current user.

  • Parameters
  • personal
    string in query

    Include, exclude or show only personal organizations.

    without_projects
    string in query

    Include, exclude or show only organizations that have no projects.

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"organizations": [
    		{
    			"id": "string",
    			"name": "string",
    			"description": "string",
    			"website": "string",
    			"twitter": "string",
    			"logo": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"projects": [
    				{
    					"href": "string"
    				}
    			],
    			"members": [
    				{
    					"href": "string"
    				}
    			],
    			"memberships": [
    				{
    					"href": "string"
    				}
    			],
    			"address": {
    				"address": "string",
    				"address2": "string",
    				"city": "string",
    				"state": "string",
    				"zip_code": "string",
    				"country": "string",
    				"coordinates": {
    					"$ref": "#\/definitions\/Coordinates"
    				}
    			},
    			"entitlement": {
    				"id": "string",
    				"description": "string",
    				"slug": "string",
    				"name": "string",
    				"weight": "integer",
    				"instance_quota": "object",
    				"project_quota": "integer",
    				"volume_quota": "object",
    				"ip_quota": "object",
    				"feature_access": "object",
    				"href": "string"
    			},
    			"terms": "integer",
    			"credit_amount": "number"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
Create an organization
/organizations

Creates an organization.

  • Parameters
  • organization
     (required) in body

    Organization to create

    {
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"address": {
    		"$ref": "#\/definitions\/Address"
    	}
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number"
    } 
  • Response  401   unauthorized
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve an organization's details
GET
/organizations/{id}

Returns a single organization's details, if the user is authorized to view it.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the organization
PUT
/organizations/{id}

Updates the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    organization
     (required) in body

    Organization to update

    {
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"address": {
    		"$ref": "#\/definitions\/Address"
    	}
    } 
  • Response  200   ok
  • {
    	"id": "string",
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"projects": [
    		{
    			"href": "string"
    		}
    	],
    	"members": [
    		{
    			"href": "string"
    		}
    	],
    	"memberships": [
    		{
    			"href": "string"
    		}
    	],
    	"address": {
    		"address": "string",
    		"address2": "string",
    		"city": "string",
    		"state": "string",
    		"zip_code": "string",
    		"country": "string",
    		"coordinates": {
    			"latitude": "string",
    			"longitude": "string"
    		}
    	},
    	"entitlement": {
    		"id": "string",
    		"description": "string",
    		"slug": "string",
    		"name": "string",
    		"weight": "integer",
    		"instance_quota": "object",
    		"project_quota": "integer",
    		"volume_quota": "object",
    		"ip_quota": "object",
    		"feature_access": "object",
    		"href": "string"
    	},
    	"terms": "integer",
    	"credit_amount": "number"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the organization
/organizations/{id}

Deletes the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    id
    string  (required) in path

    Cage UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  404   not found