Developers API reference Version 1 · generated from the code openapi.json
Routes

sharing lists

Read a sharing list

GET /api/v1/sharing-lists/{list_id}

A sharing list and its addresses.

Required scope: share

Path parameters

  • list_id integer · required

    Id of the sharing list.

Response

200 SharingList

  • id integer

    Id of the list.

  • name string

    Name of the list.

  • scope string

    Whether it is your own or belongs to the organisation.

  • emails array of string

    Its addresses, in alphabetical order.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 404

    Nothing with that id, or nothing the account may open.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt