Skip to main content
GET
/
v1
/
projects
List Projects
curl --request GET \
  --url https://api.studio.us.phrase.com/v1/projects \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "01jzmvc20cjq5hj5saa96ttp2x",
      "name": "Meeting Recording",
      "status": "IN_PROGRESS",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "firstRecordingId": "<string>",
      "sourceLanguage": "<string>",
      "subtitleProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mediaType": "AUDIO",
      "duration": 123,
      "fileCount": 123,
      "owner": "<string>",
      "accountId": "<string>",
      "archived": true,
      "recordingTypes": [
        "TRANSCRIPTION"
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

status
enum<string>
default:ALL

Filter by project status.

Available options:
ALL,
ARCHIVED,
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED
teamProjects
boolean
default:false

If true, include team projects.

Free-text search in project name.

page
integer
default:1

Page number (min 1).

Required range: x >= 1
pageSize
integer
default:1000

Items per page (1-1000).

Required range: 1 <= x <= 1000

Response

Projects retrieved successfully

data
object[]

Array of projects

pagination
object