Skip to main content
GET
Requires version 2.0.0 or later of the Archetype platform.

Overview

This endpoint returns a cursor-paginated page of the projects visible to the caller, newest first.
  • A user sees the projects they created.
  • An organization admin sees every project of the organization.
  • A service-account API key sees the projects created with service-account keys.

Request

integer
default:"100"
Page size. Minimum 1, maximum 1000.
string
Forward cursor: return projects older than the one with this id. Pass the next_cursor of the previous page to fetch the next page. Mutually exclusive with before.
string
Backward cursor: return projects newer than the one with this id. Pass the prev_cursor of the current page to walk back. Mutually exclusive with after.

Response

array
required
The page, newest first. Each entry is a project object.
boolean
required
True when more results exist beyond this page in the direction of travel.
string
Cursor for the next page in the same direction: pass it as after when paging forward, or as before when you supplied before. null when has_more is false.
string
Cursor to step back the way this page was reached: pass it as before after a forward page, or as after after a backward one. null when the request carried no cursor.

Project object

string
required
The project’s prj_ id.
string
required
Display name.
string
required
Description; empty when none was given.
string
required
Who created the project: a user’s usr_ id, or the key_ id of the service-account API key it was created with. Never changes.
string
required
When the project was created (date-time).
string
required
When the project’s name or description last changed (date-time); its creation time until then.

Important Notes

  • after and before are project ids, and are mutually exclusive. Passing both, or a malformed one, returns 400.
  • Results are ordered newest first in both cursor directions, so render data as returned.