SIsinch
Fax to Email

List emails

Changed on

List emails for the project.

get/v3/projects/{projectId}/services/{serviceId}/emails

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services/{serviceId}/emails
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

serviceIdstring required

The serviceId containing the emails you want to list.

Query parameters

pageinteger
Example:1

The page to fetch. If not specified, the first page will be returned.

pageSizeinteger
Example:20

Number of items to return on each page.

Response

A list of emails associated with the project.

pageinteger

Current page

totalPagesinteger

Total number of pages.

pageSizeinteger

Number of items per page.

totalItemsinteger

Total size of the result.

Example response

{
  "emails": [
    {
      "email": "user@domain.com",
      "phoneNumbers": [
        {
          "number": "+15551235656"
        }
      ],
      "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3"
    }
  ]
}

Changes

  • 7c729cfeab72Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • info

      added the optional property ///// to the response with the status

  • 7f5e54fa9f05Revision changes
    • info

      endpoint added