Partnership API Documentation
  1. iFrame Integration
Partnership API Documentation
  • Introduction
  • API Integration
    • Overview
    • Flowchart
    • Authentication
    • Participant Criteria
    • Publish Study
    • Get Criteria
      GET
    • Publish Study
      POST
    • Get Study Details
      GET
    • Update Study Status
      PATCH
    • Download Report
      GET
  • iFrame Integration
    • Overview
    • Request Token
      POST
    • Get Studies
      GET
  1. iFrame Integration

Get Studies

Developing
GET
https://poplite-service.qapopulix.co/api/v1/partnership/studies/{userEmail}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK
application/json
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://poplite-service.qapopulix.co/api/v1/partnership/studies/ilhammuksidin+redcomm+1@populix.co?status=DRAFT&orderBy=ASC&sortBy=createdAt&search&limit=10&page=1'
Response Response Example
200 - Success Response
{
    "traceId": "d726096b-dd14-48ac-b138-4ff330e91994",
    "result": {
        "code": "SUCCESS",
        "message": "Success",
        "data": {
            "studies": [
                {
                    "id": 141797,
                    "title": "RC subs 1109251719",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "COMPLETED",
                    "startDate": "2025-09-11T10:20:20.000Z",
                    "endDate": "2025-09-11T11:22:49.000Z",
                    "expiredDate": null,
                    "createdAt": "2025-09-11T10:19:11.727Z",
                    "updatedAt": "2025-09-11T11:22:49.327Z"
                },
                {
                    "id": 141785,
                    "title": "RC auth success 1109251210",
                    "description": "x",
                    "requiredParticipants": 2,
                    "status": "STOP",
                    "startDate": "2025-09-11T05:10:09.000Z",
                    "endDate": "2025-09-24T17:00:00.000Z",
                    "expiredDate": null,
                    "createdAt": "2025-09-11T05:08:20.107Z",
                    "updatedAt": "2025-09-11T05:11:14.096Z"
                },
                {
                    "id": 141784,
                    "title": "RC auth success 1109251202",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "STOP",
                    "startDate": "2025-09-11T05:02:58.000Z",
                    "endDate": "2025-09-24T17:00:00.000Z",
                    "expiredDate": null,
                    "createdAt": "2025-09-11T05:01:47.166Z",
                    "updatedAt": "2025-09-11T05:04:09.660Z"
                },
                {
                    "id": 141779,
                    "title": "RC co 1109251021",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "STOP",
                    "startDate": "2025-09-11T03:24:47.000Z",
                    "endDate": "2025-09-24T17:00:00.000Z",
                    "expiredDate": null,
                    "createdAt": "2025-09-11T03:21:41.450Z",
                    "updatedAt": "2025-09-11T03:25:49.466Z"
                },
                {
                    "id": 141683,
                    "title": "RC cal 1109250936",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-11T02:35:58.874Z",
                    "updatedAt": "2025-09-11T02:36:34.534Z"
                },
                {
                    "id": 141105,
                    "title": "RC checkout 1009252139",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-10T14:39:37.632Z",
                    "updatedAt": "2025-09-10T14:39:37.632Z"
                },
                {
                    "id": 141104,
                    "title": "PopSurvey Study - 27",
                    "description": "PopSurvey Study - 27",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-10T14:39:19.531Z",
                    "updatedAt": "2025-09-10T14:39:19.531Z"
                },
                {
                    "id": 141100,
                    "title": "RC cal 1009252131",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-10T14:31:38.078Z",
                    "updatedAt": "2025-09-10T14:31:38.078Z"
                },
                {
                    "id": 141099,
                    "title": "RC cal 1009252131",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-10T14:31:34.267Z",
                    "updatedAt": "2025-09-10T14:31:34.267Z"
                },
                {
                    "id": 141098,
                    "title": "RC cal 1009252131",
                    "description": "x",
                    "requiredParticipants": 1,
                    "status": "DRAFT",
                    "startDate": null,
                    "endDate": null,
                    "expiredDate": null,
                    "createdAt": "2025-09-10T14:31:31.946Z",
                    "updatedAt": "2025-09-10T14:31:31.946Z"
                }
            ],
            "pagination": {
                "currentPage": 1,
                "totalPages": 4,
                "totalItems": 33,
                "itemsPerPage": 10,
                "hasNextPage": true,
                "hasPreviousPage": false
            }
        }
    }
}
Modified at 2025-09-12 08:24:47
Previous
Request Token
Built with