Jump to

• Request
• Response

Get a list of all enabled users.

get

/social/api/v1/people

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1PeopleFilterInfo

Type: object

V1 People Filter Information.

Show Source

• excludeHidden: boolean
  True to exclude hidden users.
• isDisabled: boolean
  Return disabled users. If both isEnabled and isDisabled are false, only enabled users will be returned.
• isEnabled: boolean
  Return enabled users. If both isEnabled and isDisabled are false, only enabled users will be returned.
• startsWith: string
  Name prefix.

{
    "description":"V1 People Filter Information.",
    "properties":{
        "excludeHidden":{
            "description":"True to exclude hidden users.",
            "type":"boolean"
        },
        "isDisabled":{
            "description":"Return disabled users. If both isEnabled and isDisabled are false, only enabled users will be returned.",
            "type":"boolean"
        },
        "isEnabled":{
            "description":"Return enabled users. If both isEnabled and isDisabled are false, only enabled users will be returned.",
            "type":"boolean"
        },
        "startsWith":{
            "description":"Name prefix.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 People List Information DTO.

Root Schema : XV1PeopleListInfo

Type: object

V1 People List Information DTO.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• items: array items
  The people being returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 People List Information DTO.",
    "properties":{
        "items":{
            "description":"The people being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1PeopleInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The people being returned.

Show Source

• [0]: object XV1PeopleInfo
  V1 People Information DTO.

{
    "description":"The people being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1PeopleInfo"
    }
}

Nested Schema : XV1PeopleInfo

Type: object

V1 People Information DTO.

Show Source

• addressBuilding: string
  This user's building.
• addressCity: string
  This user's city.
• addressCountry: string
  This user's country.
• addressLine1: string
  This user's street address.
• addressLine2: string
  This user's street address second line.
• addressOffice: string
  This user's office.
• addressState: string
  This user's state.
• addressZipCode: string
  This user's ZIP Code.
• altitude: number(double)
  The object's altitude.
• biography: string
  The biography for this user.
• chatURL: string(url)
  A URL specifying this user's one-on-one conversation with the current user.
• collectionURL: string(url)
  A URL to this object's containing collection.
• company: string
  This user's company.
• conversationURL: string(url)
  A URL to this object's containing conversation.
• costCenter: string
  This user's cost center.
• createdByID:
  An object's unique identifier from a long integer representation.
• createdByURL: string(url)
  A URL to the user that created this object.
• createdByUserDisplayName: string
  The display name of the user that created this object.
• createdByUserName: string
  The name of the user that created this object.
• createdDate: string(date)
  The date this object was created.
• createdDateInISO8601Format: string
  The date this object was created, in ISO 8601 format.
• dateFormatLocale: string(uuid)
  This user's locale for formatting dates.
• description: string
  The user profile description.
• displayName: string
  The display name of this object.
• eMailAddress: string
  The email address for this user.
• expertise: string
  This user's expertise.
• followersURL: string(url)
  This user's followers URL. Users that are followers of this user.
• followingURL: string(url)
  This user's following URL. Users that this user is following.
• fullName: string
  The full name for this user.
• id:
  An object's unique identifier from a long integer representation.
• interests: string
  This user's interests.
• isDeleted: boolean
  True if this user is deleted.
• isEnabled: boolean
  True if this user is enabled.
• isHidden: boolean
  True if the user is to be hidden.
• isIntegrationUser: boolean
  True if the user is an integration user.
• isInternal: boolean
  True if the user is internal, false if the user is external.
• isOutsider: boolean
  True if the user is an outsider.
• isRemoved: boolean
  True if this message has been removed.
• languageLocale: string(uuid)
  This user's language locale.
• lastConnectedDate: string(date)
  The date this user last connected.
• lastConnectedDateInISO8601Format: string
  The date this user last connected, in ISO 8601 format.
• lastDisconnectedDate: string(date)
  The date this user last disconnected.
• lastDisconnectedDateInISO8601Format: string
  The date this user last disconnected, in ISO 8601 format.
• latitude: number(double)
  The object's latitude.
• libraryURL: string(url)
  A URL specifying this user's library.
• link: string
  A URL, if any, that this user shows on their wall or profile as their link.
• location: string
  This user's location.
• longitude: number(double)
  The object's longitude.
• modifiedByID:
  An object's unique identifier from a long integer representation.
• modifiedByURL: string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName: string
  The display name of the user that last modified this object.
• modifiedByUserName: string
  The name of the user that last modified this object.
• modifiedDate: string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format: string
  The date this object was last modified, in ISO 8601 format.
• name: string
  The name of this object.
• objectType: string
  The type of this object.
• organization: string
  This user's organization.
• originalPictureURL: string(url)
  The original picture URL.
• profilePictureURL: string(url)
  The profile picture URL (150 px by 150 px).
• propertiesURL: string(url)
  This user's properties URL.
• removedByID:
  An object's unique identifier from a long integer representation.
• removedByURL: string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName: string
  The display name of the user that last removed this object.
• removedByUserName: string
  The name of the user that last removed this object.
• removedDate: string(date)
  The date this object was removed.
• removedDateInISO8601Format: string
  The date this object was removed, in ISO 8601 format.
• scaledPictureURL: string(url)
  The scaled picture URL (44 px by 44 px).
• socialObjectURL: string(url)
  A URL to this object's containing collaboration object.
• socialObjectViewID: string
  The user's current collaboration object view ID (can be null).
• statisticsURL: string(url)
  A URL to retrieve this user's statistics.
• timeZone: string(uuid)
  This user's time zone.
• title: string
  This user's title.
• url: string(url)
  A URL to this object.
• wallURL: string(url)
  A URL specifying this user's wall.

{
    "description":"V1 People Information DTO.",
    "properties":{
        "addressBuilding":{
            "description":"This user's building.",
            "type":"string"
        },
        "addressCity":{
            "description":"This user's city.",
            "type":"string"
        },
        "addressCountry":{
            "description":"This user's country.",
            "type":"string"
        },
        "addressLine1":{
            "description":"This user's street address.",
            "type":"string"
        },
        "addressLine2":{
            "description":"This user's street address second line.",
            "type":"string"
        },
        "addressOffice":{
            "description":"This user's office.",
            "type":"string"
        },
        "addressState":{
            "description":"This user's state.",
            "type":"string"
        },
        "addressZipCode":{
            "description":"This user's ZIP Code.",
            "type":"string"
        },
        "biography":{
            "description":"The biography for this user.",
            "type":"string"
        },
        "chatURL":{
            "description":"A URL specifying this user's one-on-one conversation with the current user.",
            "type":"string",
            "format":"url"
        },
        "company":{
            "description":"This user's company.",
            "type":"string"
        },
        "costCenter":{
            "description":"This user's cost center.",
            "type":"string"
        },
        "dateFormatLocale":{
            "description":"This user's locale for formatting dates.",
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "description":"The user profile description.",
            "type":"string"
        },
        "eMailAddress":{
            "description":"The email address for this user.",
            "type":"string"
        },
        "expertise":{
            "description":"This user's expertise.",
            "type":"string"
        },
        "followersURL":{
            "description":"This user's followers URL. Users that are followers of this user.",
            "type":"string",
            "format":"url"
        },
        "followingURL":{
            "description":"This user's following URL. Users that this user is following.",
            "type":"string",
            "format":"url"
        },
        "fullName":{
            "description":"The full name for this user.",
            "type":"string"
        },
        "interests":{
            "description":"This user's interests.",
            "type":"string"
        },
        "isDeleted":{
            "description":"True if this user is deleted.",
            "type":"boolean"
        },
        "isEnabled":{
            "description":"True if this user is enabled.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"True if the user is to be hidden.",
            "type":"boolean"
        },
        "isIntegrationUser":{
            "description":"True if the user is an integration user.",
            "type":"boolean"
        },
        "isInternal":{
            "description":"True if the user is internal, false if the user is external.",
            "type":"boolean"
        },
        "isOutsider":{
            "description":"True if the user is an outsider.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"This user's language locale.",
            "type":"string",
            "format":"uuid"
        },
        "lastConnectedDate":{
            "description":"The date this user last connected.",
            "type":"string",
            "format":"date"
        },
        "lastConnectedDateInISO8601Format":{
            "description":"The date this user last connected, in ISO 8601 format.",
            "type":"string"
        },
        "lastDisconnectedDate":{
            "description":"The date this user last disconnected.",
            "type":"string",
            "format":"date"
        },
        "lastDisconnectedDateInISO8601Format":{
            "description":"The date this user last disconnected, in ISO 8601 format.",
            "type":"string"
        },
        "libraryURL":{
            "description":"A URL specifying this user's library.",
            "type":"string",
            "format":"url"
        },
        "link":{
            "description":"A URL, if any, that this user shows on their wall or profile as their link.",
            "type":"string"
        },
        "location":{
            "description":"This user's location.",
            "type":"string"
        },
        "organization":{
            "description":"This user's organization.",
            "type":"string"
        },
        "propertiesURL":{
            "description":"This user's properties URL.",
            "type":"string",
            "format":"url"
        },
        "socialObjectViewID":{
            "description":"The user's current collaboration object view ID (can be null).",
            "type":"string"
        },
        "statisticsURL":{
            "description":"A URL to retrieve this user's statistics.",
            "type":"string",
            "format":"url"
        },
        "timeZone":{
            "description":"This user's time zone.",
            "type":"string",
            "format":"uuid"
        },
        "title":{
            "description":"This user's title.",
            "type":"string"
        },
        "wallURL":{
            "description":"A URL specifying this user's wall.",
            "type":"string",
            "format":"url"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}