Projects

GET /api/v1/project (Projects)

GET /api/v1/project (Projects)

get/api/v1/project

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/project
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

projectIdstring uuid required

The project to fetch

withSearchIndexStatusboolean

If true it will check if a project has a valid search index

Response

OK

idstring uuid required
createdAtstring required
namestring required
guidancestring

Context provided to AI when generating content for this project

teamIdstring uuid required
teamNamestring required
projectTypeIdstring uuid required
previewUrlstring required
uiVersionnumber required
sampleSizenumber
searchIndexVersionstring required
searchIndexStatus'absent' | 'present' | 'unavailable' | 'unknown' required
searchIndexNextVersionstring

Experimental / internal. Subject to change or removal without notice.

searchIndexNextVersionCreatedstring

Experimental / internal. Subject to change or removal without notice.

searchIndexQueuedVersionstring

Experimental / internal. Subject to change or removal without notice.

searchIndexQueuedVersionCreatedstring

Experimental / internal. Subject to change or removal without notice.

relationshipsIndexStatus'absent' | 'outdated' | 'indexing' | 'indexed' | 'failed' required

Changes

No recorded changes to this operation across all 1 revision of this API.