GET api/User

Retrieves the user information for a given account. No parameters are needed for this function.

Request Information

Authentication Method

Partner/Account Authentication

URI Parameters

None.

Body Parameters

None.

Response Information

Successful Response:

Resource Description

Collection of User Info
NameDescriptionTypeAdditional information
username

string

 

email

string

 

name

string

 

token

string

 

roles

Collection of string

 

mobilePhone

string

 

Response Formats

application/json, text/json

Sample:
[
  {
    "username": "sample string 1",
    "email": "sample string 2",
    "name": "sample string 3",
    "token": "sample string 4",
    "roles": [
      "sample string 1",
      "sample string 2"
    ],
    "mobilePhone": "sample string 5"
  },
  {
    "username": "sample string 1",
    "email": "sample string 2",
    "name": "sample string 3",
    "token": "sample string 4",
    "roles": [
      "sample string 1",
      "sample string 2"
    ],
    "mobilePhone": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <UserInfo>
    <email>sample string 2</email>
    <mobilePhone>sample string 5</mobilePhone>
    <name>sample string 3</name>
    <roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </roles>
    <token>sample string 4</token>
    <username>sample string 1</username>
  </UserInfo>
  <UserInfo>
    <email>sample string 2</email>
    <mobilePhone>sample string 5</mobilePhone>
    <name>sample string 3</name>
    <roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </roles>
    <token>sample string 4</token>
    <username>sample string 1</username>
  </UserInfo>
</ArrayOfUserInfo>