List Jobs

Retrieve a paginated list of jobs with optional filtering and sorting.

GET /v2/jobs

List Jobs

cURL

curl --request GET \
  --url https://api.tryhamsa.com/v2/jobs \
  --header 'Authorization: <api-key>'

200

{
  "success": true,
  "message": "Operation completed successfully",
  "messageKey": "OPERATION_SUCCESSFUL",
  "data": {
    "jobs": [
      {
        "id": "5b171552-c5f7-42a9-ad92-c7945460dbb5",
        "title": "كلام البيزنس اللي كلنا بنستناه في اي Deal | شارك تانك مصر | الموسم الرابع",
        "mediaUrl": "https://www.youtube.com/watch?v=dLIKa3TimOM",
        "mediaType": "YOUTUBE",
        "totalCost": 7,
        "status": "COMPLETED",
        "createdAt": "2025-12-21T01:27:45.979Z"
      }
    ],
    "page": 1,
    "totalCount": 50,
    "totalPages": 5
  }
}

Authorizations

Authorization · string · header · required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

projectId · string<uuid> · required

The unique identifier of the project

Example:

"b8f820ac-2830-4eb8-be86-b7af9c8b92f0"

page · integer · required

Current page number

Example:

1

perPage · integer · required

Number of jobs per page

Example:

10

sortBy · enum<string>

Field to sort by

Available options: totalCost, usageTime, createdAt, updatedAt

Example:

"usageTime"

orderBy · enum<string>

Sort direction

Available options: asc, desc

Example:

"asc"

status · string

Job status to filter by (e.g., PENDING, COMPLETED)

Example:

"PENDING"

type · string · required

Job type to filter by (e.g., TRANSCRIPTION, AI_CONTENT)

Example:

"TRANSCRIPTION"

search · string

Free text search on job fields

Example:

"AI_CONTENT"

Response

200

application/json

Successful response with job list

success · boolean

Example:

true

message · string

Example:

"Operation completed successfully"

messageKey · string

Example:

"OPERATION_SUCCESSFUL"

data · object

Show child attributes