Nurama Developers
Projects

Get submissions for a project

Requires `canGetSubmission`. Callers holding `canCreateSubmission` also see staged `unreleased` submissions; everyone else sees only `active` ones. Index pagination is the default; pass `paginate=cursor` for cursor pagination (cursor-only parameters are rejected with index pagination, and `page`, `createdBefore`, `createdAfter` are rejected with cursor pagination).

GET
/projects/{projectId}/submission

Requires canGetSubmission. Callers holding canCreateSubmission also see staged unreleased submissions; everyone else sees only active ones. Index pagination is the default; pass paginate=cursor for cursor pagination (cursor-only parameters are rejected with index pagination, and page, createdBefore, createdAfter are rejected with cursor pagination).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

Unique ID of the project.

Formatuuid

Query Parameters

paginate?string

Pagination mode. Cursor-only parameters are rejected when index; page is rejected when cursor.

Default"index"

Value in

  • "cursor"
  • "index"
sort?

Sorting criteria

Default

{  "createdAt": -1}
search?string

Case-insensitive substring match against submission subject.

Lengthlength <= 200
limit?number

Number of results per page

Rangevalue <= 100
Default20
page?number

Page number (only accepted with paginate=index).

cursor?string

Cursor for pagination (only accepted with paginate=cursor).

paginateReverse?boolean

If true, paginates in reverse order (only accepted with paginate=cursor).

includeCounts?boolean

If true, includes count information (only accepted with paginate=cursor).

includeCursorRecord?boolean

If true, includes the cursor record in results (only accepted with paginate=cursor).

startAt?string

ID of the record to start pagination from (only accepted with paginate=cursor).

Formatuuid
includeStartAtRecord?boolean

If true, includes the startAt record in the results (only accepted with paginate=cursor).

createdBefore?|

Timestamp or ID indicating the upper bound of result creation time. You may preface an ID with a '+' to make the results inclusive of that result Meaning <= instead of just <.

Defaultnull
createdAfter?|

Timestamp or ID indicating the lower bound of result creation time. You may preface an ID with a '+' to make the results inclusive of that result Meaning <= instead of just <.

Defaultnull
chatMessageSort?

Sorting criteria for embedded chat messages

Default

{  "id": -1}
chatReplySort?

Sorting criteria for embedded chat replies

Default

{  "id": -1}
chatMessageLimit?number

Maximum number of embedded chat messages to return per chat

Rangevalue <= 100
Default10
chatReplyLimit?number

Maximum number of embedded replies to return per message

Rangevalue <= 100
Default10

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/submission"
{  "page": 0,  "limit": 0,  "totalPages": 0,  "totalResults": 0,  "queryAt": 0,  "results": [    {      "chatType": "submission",      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",      "project": [        "9ec8a81a-31b2-4a83-bcd8-cef9150932d2"      ],      "publisherId": "f1ba8124-cabe-46cd-b4f9-1189594ff7b3",      "publisher": [        "8d4ec432-66ee-43f4-8b6b-e74ac867b2f5"      ],      "subject": "string",      "description": "string",      "version": "string",      "assetIds": [        "96fa1cd8-4f1c-475e-ac07-c52694e711b7"      ],      "assetInventory": {},      "participants": [        "e3139958-26f5-4fd4-a9c9-fe1c29c5cbac"      ],      "annotations": [        {}      ],      "totalMessages": 0,      "lastMessageAt": "2019-08-24T14:15:22Z",      "recentMessages": [        "6738c803-41a8-4296-a5bd-8d9974ec6fa0"      ],      "tags": [],      "status": "active",      "createdAt": 1678886400000,      "updatedAt": 1678886400000    }  ]}