Skip to main content
GET
/
v1
/
campaigns
/
role
/
results
Get campaign results
curl --request GET \
  --url https://api.external.hirednow.ai/v1/campaigns/role/results \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "b7048779-259e-4c64-b7bf-2fb54403e936",
      "recommendation_status": "RECOMMENDED",
      "campaign": {
        "id": "5c8e2a9f-7b4d-4e1c-9a6f-3d8b5e1a7c4f",
        "name": "Summer Sales Campaign 2024"
      },
      "user": {
        "id": "2c9d4b8a-1e5f-4a7c-9b3d-6e8f1a2c4b5d",
        "email": "userZ@gmail.com"
      },
      "overall_score": 3.37,
      "additional_scores": {
        "cefr": {
          "score": "C1"
        }
      },
      "created_at": "2025-05-29T00:01:42.277Z",
      "updated_at": "2025-04-29T00:01:42.277Z",
      "order_index": "71747"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "recommendation_status": "STRONGLY_RECOMMENDED",
      "campaign": {
        "id": "5c8e2a9f-7b4d-4e1c-9a6f-3d8b5e1a7c4f",
        "name": "Holiday Promotion 2024"
      },
      "user": {
        "id": "9e5a2c8f-4b1d-4e7a-8c3f-1b6d9a5e2c8f",
        "email": "jane.doe@example.com"
      },
      "overall_score": 4.2,
      "additional_scores": {},
      "created_at": "2025-05-28T14:30:15.123Z",
      "updated_at": "2025-05-28T16:45:30.456Z",
      "order_index": "71686"
    },
    {
      "id": "d4e9f2a1-7b3c-4d8e-a5f6-1c2d3e4f5a6b",
      "recommendation_status": "NOT_RECOMMENDED",
      "campaign": {
        "id": "5c8e2a9f-7b4d-4e1c-9a6f-3d8b5e1a7c4f",
        "name": "Q4 Performance Review"
      },
      "user": {
        "id": "0a5f53fd-5982-4390-b0a1-9c1d1ade78e7",
        "email": "john.smith@company.com"
      },
      "overall_score": 2.38,
      "additional_scores": {
        "cefr": {
          "score": "B1"
        }
      },
      "created_at": "2025-10-30T13:37:43.175Z",
      "updated_at": "2025-10-30T13:37:43.175Z",
      "order_index": "71680"
    }
  ],
  "has_more": true,
  "last_record_index": "71680"
}
This endpoint returns results for campaigns with type: "ROLE_SUBMISSION".

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
campaign_id
string<uuid>
required

Unique identifier for the campaign

​
limit
integer
default:10

Number of results to return

Required range: 1 <= x <= 100
​
sort
enum<string>
default:desc

Sort order for the results

Available options:
desc,
asc
​
start_date
string<date>

Start date for filtering results (YYYY-MM-DD format)

Pattern: ^\d{4}-\d{2}-\d{2}$
​
end_date
string<date>

End date for filtering results (YYYY-MM-DD format)

Pattern: ^\d{4}-\d{2}-\d{2}$
​
starting_after
integer<int64>

Pagination cursor - results after this big integer value

​
report_type
enum<string>
default:OVERALL

Type of report to generate

Available options:
DETAILED,
OVERALL

Response

Campaign results response

Response for OVERALL report type

​
data
object[]

Array of campaign result records

​
has_more
boolean

Indicates whether there are more results available for pagination

​
last_record_index
string

The order index of the last record in the current page, used for pagination