Home
Version 3
Organizations API

Organizations API

Retrieve a Particular Organization

GET /v2/organizations/:guid

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNyIsImVtYWlsIjoiZW1haWwtMTUxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.Q0JZDK43y8zKmLkJ0l4XYDMUDI5rd38ERSOPzlgBLII
Host: example.org
Cookie: 

Route

GET /v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938

cURL

curl "https://api.[your-domain.com]/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNyIsImVtYWlsIjoiZW1haWwtMTUxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDF9.Q0JZDK43y8zKmLkJ0l4XYDMUDI5rd38ERSOPzlgBLII" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3d1cb48c-c0e5-4f07-b057-58246b9799a0
Content-Length: 1304
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "metadata": {
    "guid": "62687c78-dc73-4c2f-82a6-0fc2c3d59938",
    "url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938",
    "created_at": "2014-11-05T01:02:21+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "name-753",
    "billing_enabled": false,
    "quota_definition_guid": "d09b7a8c-3071-4352-b31f-c4b8be9a19c1",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/d09b7a8c-3071-4352-b31f-c4b8be9a19c1",
    "spaces_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/spaces",
    "domains_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/domains",
    "private_domains_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/private_domains",
    "users_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/users",
    "managers_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/managers",
    "billing_managers_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/billing_managers",
    "auditors_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/auditors",
    "app_events_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/app_events",
    "space_quota_definitions_url": "/v2/organizations/62687c78-dc73-4c2f-82a6-0fc2c3d59938/space_quota_definitions"
  }
}