Read a distribution list
const url = 'https://calendar.work.optidata.cloud/api/groups/distribution-list?email=engineering%40acme.example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://calendar.work.optidata.cloud/api/groups/distribution-list?email=engineering%40acme.example' \ --header 'Authorization: Bearer <token>'Looks a distribution list up by its e-mail address and returns its identifiers. A distribution list is a mail-addressable group: inviting the list invites everybody on it.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”Address of the distribution list.
Responses
Section titled “ Responses ”The distribution list.
object
Identifier of the list.
Examples
{ "zid": "5a1c1f7e-9f2d-4a6b-8a30-1c0d9d2f4b11", "email": "engineering@acme.example"}Missing, malformed or expired authentication key.
Authentication failures use an error key rather than message.
object
Examples
No bearer token sent
{ "error": "JWT passport exception: Missing bearer token in request"}No distribution list has that address.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "Distribution list not found"}The request body or query string failed validation.
object
The first validation message.
Validation messages keyed by field name.
object
Examples
{ "message": "The event title field is required.", "errors": { "title": [ "The event title field is required." ] }}Rate limit exceeded. Retry after the window resets.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "Too Many Attempts."}