Retrieve collection of accounts

get

/services/rest/connect/v1.4/accounts

Request

Supported Media Types
Query Parameters
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name
  • The requested page size, which limits the number of elements the collection should max return
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Returns the count of elements as the given order. The value is a comma delimited string. Each token in the string is the name of the field, optionally followed by asc or desc.
  • Query parameter that allows searching by providing ROQL WHERE clause filtering
  • Indicates whether or not to calculate the totalResults property. By default, totalResults is not calculated.

Response

Supported Media Types

Default Response

Body ()
Collection of accounts
Root Schema : accounts-collection
Type: object
Collection of accounts
Show Source

Examples

Use GET with the following syntax to list all accounts:

https://your_site_interface/services/rest/connect/version/accounts

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/accounts

Response body example

{
    "items": [
    {
        "id": 1,
        "lookupName": "Administrator",
        "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/1"
            }
            ]
        },
    {
        "id": 2,
        "lookupName": "Snowball Cat",
        "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            }
            ]
        },
    ...
    {
        "id": 254,
        "lookupName": "Random User",
        "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/254"
            }
            ]
        }
    ],
    "links": [
    {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts"
        },
    {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts"
        },
    {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts"
        },
    {
        "rel": "alternate",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts",
        "mediaType": "application/schema+json"
        }
    ]
}