Skip to main content
GET
/
v1
/
projects
Retrieve all projects
curl --request GET \
  --url https://api.example.com/v1/projects \
  --header 'Authorization: <api-key>'
{
  "status": "success",
  "message": "Project retrieved successfully",
  "projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
Note: This operation does not consume any account credits, but rate limits apply.

​
Retrieve All Projects

This endpoint retrieves all projects associated with the authenticated user. You can optionally sort the results by fields such as updatedAt or createdAt.

​
Request

  • Endpoint: GET /v1/projects
  • Authorization: Bearer token required

​
Query Parameters

  • sort (string, optional): Specifies the field to sort by, either the date the project was created (createdAt) or when it was last updated (updatedAt). Defaults to updatedAt.
  • order (string, optional): Specifies the sort order, either ascending (asc) or descending (desc). Defaults to desc.

​
Response

A successful response will return an array of projects.

​
Example Response

[
   {
      "id": "project123",
      "name": "Marketing Video Project",
      "createdAt": "2024-11-05T10:00:00.000Z",
      "updatedAt": "2024-11-06T14:30:00.000Z"
   },
   {
      "id": "project456",
      "name": "Sales Video Project",
      "createdAt": "2024-11-03T09:15:00.000Z",
      "updatedAt": "2024-11-04T11:20:00.000Z"
   }
]

Authorizations

​
Authorization
string
header
required

Use format Bearer YOUR_API_KEY.

Query Parameters

​
sort
enum<string>
default:updatedAt
Available options:
updatedAt,
createdAt
​
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Projects retrieved successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Project retrieved successfully"

​
projects
object[]