Organisations
List an organisation's auditor share links
The share links, newest first, live and ended, with how often each was opened.
GET
/orgs/{org}/evidence/sharesTL;DR
| Question | Answer |
|---|---|
| What does it do? | List an organisation's auditor share links. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type EvidenceShareList. |
| What can go wrong? | 401 not signed in; 403 a member or a reader (orgs.forbidden), or a plan without compliance evidence (plan.compliance_evidence_not_included); 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The share links, newest first, live and ended, with how often each was opened. Never an address. The owner and admins, on Enterprise.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The links. | EvidenceShareList |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden), or a plan without compliance evidence (plan.compliance_evidence_not_included). | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type EvidenceShareList.
| Field | Type | Required | Description |
|---|---|---|---|
shares | EvidenceShare[] | yes | |
shares[].id | string | yes | |
shares[].framework | "pci-dss" | "soc2" | "iso27001" | "nist-800-53" | "all" | yes | |
shares[].from | string | yes | |
shares[].to | string | yes | |
shares[].paper | "a4" | "letter" | yes | |
shares[].label | string | null | yes | |
shares[].protection | "none" | "password" | "emails" | yes | |
shares[].emails | string[] | yes | |
shares[].createdBy | string | null | yes | |
shares[].createdAt | integer | yes | |
shares[].expiresAt | integer | yes | |
shares[].revokedAt | integer | null | yes | |
shares[].views | integer | yes | minimum 0. |
shares[].lastViewedAt | integer | null | yes | |
shares[].state | "live" | "expired" | "revoked" | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |