Home
Version 3
Users API

Users API

List all Users

GET /v2/users

Request

Route

GET /v2/users

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU1IiwiZW1haWwiOiJlbWFpbC0yNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ1NTU3OTI5fQ.rT4gdbRvbs3rIf_0xxvknLwnZGK8G3oKWiaATiAjzV0
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "uaa-id-54",
        "url": "/v2/users/uaa-id-54",
        "created_at": "2015-10-15T23:52:09Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": false,
        "default_space_guid": "b7a86645-1865-4e65-95fd-06cd26cf65e0",
        "username": "user@example.com",
        "default_space_url": "/v2/spaces/b7a86645-1865-4e65-95fd-06cd26cf65e0",
        "spaces_url": "/v2/users/uaa-id-54/spaces",
        "organizations_url": "/v2/users/uaa-id-54/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-54/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-54/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-54/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-54/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-54/audited_spaces"
      }
    },
    {
      "metadata": {
        "guid": "uaa-id-55",
        "url": "/v2/users/uaa-id-55",
        "created_at": "2015-10-15T23:52:09Z",
        "updated_at": null
      },
      "entity": {
        "admin": false,
        "active": true,
        "default_space_guid": null,
        "spaces_url": "/v2/users/uaa-id-55/spaces",
        "organizations_url": "/v2/users/uaa-id-55/organizations",
        "managed_organizations_url": "/v2/users/uaa-id-55/managed_organizations",
        "billing_managed_organizations_url": "/v2/users/uaa-id-55/billing_managed_organizations",
        "audited_organizations_url": "/v2/users/uaa-id-55/audited_organizations",
        "managed_spaces_url": "/v2/users/uaa-id-55/managed_spaces",
        "audited_spaces_url": "/v2/users/uaa-id-55/audited_spaces"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 00b467d4-3d3d-4912-b9cf-11404ed5169f
Content-Length: 1874
X-Content-Type-Options: nosniff