Home
Version 3
Users API

Users API

List all Users

GET /v2/users

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: space_guid, organization_guid, managed_organization_guid, billing_managed_organization_guid, audited_organization_guid, managed_space_guid, audited_space_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OCIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjV9.uirrh-L0NSEaGQkketYffIxpLH4jOW47Wjx-EhL3N3s
Host: example.org
Cookie: 

Route

GET /v2/users

cURL

curl "https://api.[your-domain.com]/v2/users" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0OCIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjV9.uirrh-L0NSEaGQkketYffIxpLH4jOW47Wjx-EhL3N3s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e11b1051-b73c-4689-9af4-57cdd555df21
Content-Length: 1862
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-247",
        "url": "/v2/users/uaa-id-247",
        "created_at": "2014-11-24T19:32:45+00:00",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": "ef8fe9d6-23f3-48c6-8b03-720db6cbcf61",
        "default_space_url": "/v2/spaces/ef8fe9d6-23f3-48c6-8b03-720db6cbcf61",
        "spaces_url": "/v2/users/uaa-id-247/spaces",
        "organizations_url": "/v2/users/uaa-id-247/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-247/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-247/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-247/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-247/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-247/audited_spaces"
      }
    },
    {
      "metadata": {
        "guid": "uaa-id-248",
        "url": "/v2/users/uaa-id-248",
        "created_at": "2014-11-24T19:32:45+00:00",
        "updated_at": null
      },
      "entity": {
        "admin": true,
        "active": false,
        "default_space_guid": null,
        "spaces_url": "/v2/users/uaa-id-248/spaces",
        "organizations_url": "/v2/users/uaa-id-248/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-248/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-248/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-248/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-248/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-248/audited_spaces"
      }
    }
  ]
}