GET v1/Users/Flat?portal={portal}

Gets a list of users from the parameters provided, supports the csv format

Request Information

URI Parameters

Name	Description	Type	Additional information
portal	The portal context for which you will be retrieving users	string	Required

Body Parameters

None.

Response Information

Resource Description

A collection of users

Collection of FlatUser

Name	Description	Type	Additional information
userId	Identifier for the user. Used to uniquely identify a user	integer	None.
name	The name of the usre	string	None.
email	Email of the User	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "userId": 1,
    "name": "sample string 2",
    "email": "sample string 3"
  },
  {
    "userId": 1,
    "name": "sample string 2",
    "email": "sample string 3"
  }
]

text/xml

Sample:

<ArrayOfFlatUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitySpark.API.Models">
  <FlatUser>
    <email>sample string 3</email>
    <name>sample string 2</name>
    <userId>1</userId>
  </FlatUser>
  <FlatUser>
    <email>sample string 3</email>
    <name>sample string 2</name>
    <userId>1</userId>
  </FlatUser>
</ArrayOfFlatUser>

text/csv

Sample:

userId,name,email
1,sample string 2,sample string 3
1,sample string 2,sample string 3