Skip to content
Connect an agent

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/shares

TL;DR

QuestionAnswer
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

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.

Responses

StatusMeaningBody
200The links.EvidenceShareList
401Not signed in.ErrorResponse
403A member or a reader (orgs.forbidden), or a plan without compliance evidence (plan.compliance_evidence_not_included).ErrorResponse
404No such organisation, or the caller is not a member of it.ErrorResponse
429Too many requests.ErrorResponse
503Organisations are not set up on this server.ErrorResponse

Response body

A 200 answer has the type EvidenceShareList.

FieldTypeRequiredDescription
sharesEvidenceShare[]yes
shares[].idstringyes
shares[].framework"pci-dss" | "soc2" | "iso27001" | "nist-800-53" | "all"yes
shares[].fromstringyes
shares[].tostringyes
shares[].paper"a4" | "letter"yes
shares[].labelstring | nullyes
shares[].protection"none" | "password" | "emails"yes
shares[].emailsstring[]yes
shares[].createdBystring | nullyes
shares[].createdAtintegeryes
shares[].expiresAtintegeryes
shares[].revokedAtinteger | nullyes
shares[].viewsintegeryesminimum 0.
shares[].lastViewedAtinteger | nullyes
shares[].state"live" | "expired" | "revoked"yes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools