GET v1/Users?portal={portal}&includePromotions={includePromotions}&includeSubmissions={includeSubmissions}&startDate={startDate}&numberOfDays={numberOfDays}
Gets a list of users from the parameters provided
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portal |
The portal context for which you will be retrieving users |
string |
Required |
| includePromotions |
Indicates whether or not to include promotions. Default is true |
boolean |
None. |
| includeSubmissions |
Indicates whether or not to include submissions. Default is true |
boolean |
None. |
| startDate |
If includeSubmissions then include submissions as of this date. Defaults to today. |
date |
None. |
| numberOfDays |
Used in correlation with the startDate to determine how many days of promotions or submissions to include. Defaults to 30. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
A collection of users
GetUsersResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| users | Collection of UserSeries |
None. |
Response Formats
application/json, text/json
Sample:
{
"users": [
{
"userId": 1,
"name": "sample string 2",
"email": "sample string 3",
"promos": [
{
"eventName": "sample string 1",
"amount": 2.0,
"type": "sample string 3",
"orderDate": "2025-03-15T23:14:55.2476605+00:00",
"eventId": 1,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
]
},
{
"eventName": "sample string 1",
"amount": 2.0,
"type": "sample string 3",
"orderDate": "2025-03-15T23:14:55.2476605+00:00",
"eventId": 1,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
]
}
],
"submissions": [
{
"eventName": "sample string 1",
"eventId": 2,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
],
"submitDate": "2025-03-15T23:14:55.2476605+00:00"
},
{
"eventName": "sample string 1",
"eventId": 2,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
],
"submitDate": "2025-03-15T23:14:55.2476605+00:00"
}
]
},
{
"userId": 1,
"name": "sample string 2",
"email": "sample string 3",
"promos": [
{
"eventName": "sample string 1",
"amount": 2.0,
"type": "sample string 3",
"orderDate": "2025-03-15T23:14:55.2476605+00:00",
"eventId": 1,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
]
},
{
"eventName": "sample string 1",
"amount": 2.0,
"type": "sample string 3",
"orderDate": "2025-03-15T23:14:55.2476605+00:00",
"eventId": 1,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
]
}
],
"submissions": [
{
"eventName": "sample string 1",
"eventId": 2,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
],
"submitDate": "2025-03-15T23:14:55.2476605+00:00"
},
{
"eventName": "sample string 1",
"eventId": 2,
"categories": [
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
},
{
"categoryId": 1,
"parentCategoryId": 1,
"name": "sample string 2"
}
],
"submitDate": "2025-03-15T23:14:55.2476605+00:00"
}
]
}
]
}
text/xml
Sample:
<GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitySpark.API.Models">
<users>
<UserSeries>
<email>sample string 3</email>
<name>sample string 2</name>
<promos>
<UserPromotion>
<amount>2</amount>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventName>sample string 1</eventName>
<orderDate>2025-03-15T23:14:55.2476605+00:00</orderDate>
<type>sample string 3</type>
</UserPromotion>
<UserPromotion>
<amount>2</amount>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventName>sample string 1</eventName>
<orderDate>2025-03-15T23:14:55.2476605+00:00</orderDate>
<type>sample string 3</type>
</UserPromotion>
</promos>
<submissions>
<UserSubmission>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventId>2</eventId>
<eventName>sample string 1</eventName>
<submitDate>2025-03-15T23:14:55.2476605+00:00</submitDate>
</UserSubmission>
<UserSubmission>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventId>2</eventId>
<eventName>sample string 1</eventName>
<submitDate>2025-03-15T23:14:55.2476605+00:00</submitDate>
</UserSubmission>
</submissions>
<userId>1</userId>
</UserSeries>
<UserSeries>
<email>sample string 3</email>
<name>sample string 2</name>
<promos>
<UserPromotion>
<amount>2</amount>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventName>sample string 1</eventName>
<orderDate>2025-03-15T23:14:55.2476605+00:00</orderDate>
<type>sample string 3</type>
</UserPromotion>
<UserPromotion>
<amount>2</amount>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventName>sample string 1</eventName>
<orderDate>2025-03-15T23:14:55.2476605+00:00</orderDate>
<type>sample string 3</type>
</UserPromotion>
</promos>
<submissions>
<UserSubmission>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventId>2</eventId>
<eventName>sample string 1</eventName>
<submitDate>2025-03-15T23:14:55.2476605+00:00</submitDate>
</UserSubmission>
<UserSubmission>
<categories>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
<EventCategory>
<categoryId>1</categoryId>
<name>sample string 2</name>
<parentCategoryId>1</parentCategoryId>
</EventCategory>
</categories>
<eventId>2</eventId>
<eventName>sample string 1</eventName>
<submitDate>2025-03-15T23:14:55.2476605+00:00</submitDate>
</UserSubmission>
</submissions>
<userId>1</userId>
</UserSeries>
</users>
</GetUsersResponse>