Introduction
The GetUserUploadedList API is used to retrieve a paginated list of images uploaded by a specific user. This API returns metadata about each uploaded asset, such as image dimensions, file identifiers, and production-related attributes.
It is typically used in applications where users upload images for customization, printing, or design workflows.
Use Cases
The UploadUserPhoto API is used to retrieve the list of logos uploaded by a user. This data is utilized in the My Art section, where previously uploaded logos are displayed based on the specific user.
API Details
Endpoint
GET /api/4/UploadImage/GetUserUploadedList
Sample Request:
curl --location 'https://api.artifi.net/api/4/UploadImage/GetUserUploadedList?userId=72&pageIndex=1&pageSize=25&isBrandDetectionEnable=false' \
--header 'websiteId: 31' \
--header 'webApiClientKey: 2b508463-acec-44c4-9b01-9b0de30adf15'
Parameters
Header Validation
Header Name | Type | Required | Description |
websiteId | int | Yes | Unique identifier of the website. |
webApiClientKey | string | Yes | API client key used for authentication. |
Query Parameters
Name | Type | Required | Default | Description |
userId | string | Yes |
| User identifier |
pageSize | int | No | APIConstants.PageSize | Number of images per page |
pageIndex | int | No | 1 | Page number for pagination |
searchKey | string | No | "" | Search term to filter images |
isBrandDetectionEnable | bool | No | false | Enable brand detection filtering |
Success Responses
{
"Response": "Success",
"Message": "",
"Data": {
"AssetCount": 888,
"AssetList": [
{
"Id": 340928,
"UniqueName": "2025_12_a720b7e7-5fe7-415d-854a-2e408afbabd6.png",
"ImageName": "ArtifiLogo",
"Width": 355,
"Height": 142,
"IsPrintImagePresent": false,
"PrintImageUniqueName": null,
"EmbStitchCount": 0,
"EmbColorCount": 0,
"ThreadList": null,
"IsProductionReady": false
}
]
},
"ErrorCode": ""
}
Error Code List (Click Here)
Error Code
Source | Code | Message |
Header validation | 372 | Missing or empty required header: websiteId |
Header validation | 221 | The websiteId header must be a numeric value |
Header validation | 221 | The websiteId cannot be 0. Please provide a valid websiteId |
Header validation | 226 | The webApiClientKey header cannot be empty |
Input validation | 261 | Invalid or missing userId |
Exception | 500 | Exception occurred while retrieving a user's uploaded photo |
Q&A
1. What does the GetUserUploadedList API do?
The GetUserUploadedList API retrieves a paginated list of images uploaded by a specific user, including metadata such as image name, size, dimensions, and production-related details.
2. What type of API is the GetUserUploadedList API?
The GetUserUploadedList API is a GET API used for fetching user-uploaded image data from the server.
3. Is authentication required for the GetUserUploadedList API?
Yes, the GetUserUploadedList API requires a valid webApiClientKey to authenticate the request.
4. What are the mandatory parameters in the GetUserUploadedList API?
The required parameters in the GetUserUploadedList API are:
- userId
- pageIndex
- pageSize
- websiteId
- webApiClientKey
5. What is the purpose of pageIndex and pageSize in the GetUserUploadedList API?
In the GetUserUploadedList API:
- pageIndex specifies the page number (starting from 1)
- pageSize defines the number of records returned per request
6. What does isBrandDetectionEnable do in the GetUserUploadedList API?
In the GetUserUploadedList API, this optional flag enables or disables brand detection logic for uploaded images.
7. What happens if I pass an invalid userId in the GetUserUploadedList API?
If an invalid userId is passed in the GetUserUploadedList API, the request will fail and return a 400 Bad Request response. The API provides a structured error response indicating that the user ID is invalid.
Sample Error Response:
{
"Response": "Error",
"Message": "Invalid user id.",
"Data": null,
"ErrorCode": "227"
}