HOhootsuite
SCIM 2.0

Get Users

Retrieves Hootsuite users using the SCIM 2.0 protocol. Support equals filtering on username.

get/scim/v2/Users

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/scim/v2/Users
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Query parameters

filterstring

Filtering by username.

countnumber

The maximum number of results to return.

startIndexnumber

The starting index for pagination.

Headers

Authorizationstring required

A bearer token string used for authentication

Response

Success

totalResultsnumber

The total number of users found

startIndexnumber

The current offset used for result paging

itemsPerPagenumber

The page size used for paging

schemasstring[]

Example response

{
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "3918310",
      "meta": {
        "resourceType": "User",
        "created": "2012-05-07T15:36:18.000Z",
        "lastModified": "2015-04-21T21:25:40.000Z"
      },
      "userName": "joe.smith@hootsuite.com",
      "name": {
        "givenName": "joe.smith",
        "familyName": "joe.smith"
      },
      "emails": [
        {
          "primary": true,
          "value": "joe.smith@hootsuite.com",
          "type": "work"
        }
      ],
      "displayName": "Joe Smith",
      "timezone": "America/Vancouver",
      "preferredLanguage": "en",
      "title": "Manager",
      "active": true
    }
  ],
  "totalResults": 8,
  "startIndex": 1,
  "itemsPerPage": 10,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.