Skip to main content
POST
Get All Projects

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request parameters for retrieving all projects. All optional.

query
string

Case-insensitive substring matched against project name or url. Pass the brand/domain the user mentioned (e.g. 'writesonic') to get just the matching project(s) — recommended when you only need one project's id, as it keeps the response small.

limit
integer
default:50

Max projects to return (1-100).

Required range: 1 <= x <= 100
offset
integer
default:0

Number of projects to skip, for paging.

Required range: x >= 0

Response

Successful Response

Response containing project data.

data
ProjectDataItem · object[]
required

Array of project data items

total
integer
default:0

Total projects matching the query (before limit/offset).

limit
integer
default:50

Applied page size.

offset
integer
default:0

Applied offset.