Read one monthly client brief or a range of briefs
GET
/client-watches/{storeId}/briefRequires scope: read:watch
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
storeIdrequired | path | string | |
period | query | string | Calendar UTC period in YYYYMM form. Use this alone, or use both from and to. |
from | query | string | First calendar UTC period in a range of at most 12 periods. |
to | query | string | Last calendar UTC period in a range of at most 12 periods. |
Responses
| Status | Description |
|---|---|
200 | Known client-watch result |
400 | Invalid stores, mode, period, range, cursor, or limit |
401 | Missing or invalid watch credential |
403 | Credential lacks the required watch scope or a human principal |
404 | Client Watch is unavailable, the account is not visible, or no stored brief exists |
409 | Client Watch is not offered, cannot be funded, or cannot be settled safely |
503 | Watch authorization or client-watch data is unavailable |
Is this page helpful?