List assignments for a collection order

GET

/v1/projects/{projectId}/collection-orders/{orderId}/assignments

curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/collection-orders/{orderId}/assignments' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
orderIdstringrequired

Query parameters

pageSizenumber
Page size (default 25, maximum 100). Over-maximum is refused.
pageTokenstring
Opaque page token from the previous response.

Responses

Success

dataarray<CollectionAssignmentDto>required
- idstringrequired
- orderIdstringrequired
- taskIdstring | nullrequired
- collectorMembershipIdstringrequired
- collectorNamestring | nullrequired
- statusstringrequired
  Allowed values
  active
  removed
- assignedBystring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
nextPageTokenstring
Opaque AIP-158 page token. Omitted when the collection is exhausted.
metaobjectrequired
- pageSizenumberrequired
- totalCountnumber
- truncatedone of
- requestIdstring

Response example

{
  "data": [
    {
      "id": "string",
      "orderId": "string",
      "taskId": "string",
      "collectorMembershipId": "string",
      "collectorName": "string",
      "status": "active",
      "assignedBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "nextPageToken": "string",
  "meta": {
    "pageSize": 0,
    "totalCount": 0,
    "truncated": false,
    "requestId": "string"
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1