Skip to main content
GET
List projects

Authorizations

Authorization
string
header
required

Access token obtained from POST /auth (client_id + client_secret). Valid for 300 seconds.

Headers

X-Sub-Account
string

Reference of the sub-account the operation runs against. When omitted, the operation happens on the main account; the reserved value principal also resolves to the main account and is equivalent to omitting the header. Accepted on every endpoint except POST /auth and the /sub-accounts endpoints themselves, which always operate on the main account.

Possible errors: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Requires the credential to have sub-account access enabled (Settings → Integration → API Credentials). It starts turned off and is not replaced by any permission, not even FULL_ACCESS: without it the response is 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Example:

"loja-centro"

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt,
name
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

List of projects

items
object[]
required

List of projects

total
integer
required

Total number of projects

Example:

100

page
integer
required

Current page

Example:

1

limit
integer
required

Items per page

Example:

20

totalPages
integer
required

Total number of pages

Example:

5