v4

latestSwagger 2.02026-08-0343714211.7 MB
user_additional_email_recipients
User Additional Email Recipients

List User Additional Email Recipients

List User Additional Email Recipients

get/user_additional_email_recipients

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are email, user_id or workspace_id.

If set, return records where the specified field is equal to the supplied value. Valid fields are email, workspace_id or user_id. Valid field combinations are [ workspace_id, email ], [ user_id, email ], [ workspace_id, user_id ] or [ workspace_id, user_id, email ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are email.

Response

A list of UserAdditionalEmailRecipients objects.

idinteger

User additional email recipient ID

user_idinteger

User ID

workspace_idinteger

Workspace ID (0 for default workspace).

emailstring

Additional email recipient address

created_atstring date-time

Created at date/time

Example response

[
  {
    "id": 1,
    "user_id": 1,
    "email": "user-copy@example.com",
    "created_at": "2000-01-01T01:00:00Z"
  }
]