SIsinch
Cover pages

List cover pages

Changed on

Lists the cover pages on a service. To retrieve the cover page file, use the Get a cover page operation to download it.

get/v3/projects/{projectId}/services/{id}/coverPages

Request

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

Response

List of coverpages Error

pageinteger

Current page

totalPagesinteger

Total number of pages.

pageSizeinteger

Number of items per page.

totalItemsinteger

Total size of the result.

Example response

{
  "coverPages": [
    {
      "name": "Acme Company cover page",
      "projectId": "ae00f005-e392-44dc-b3f5-a657a2684dg3",
      "serviceId": "01GVRB50KEQFFE1SGMPFRNBG6J",
      "createdTime": "2025-10-24 18:56:42+00:00",
      "updatedTime": "2025-10-24 19:11:50+00:00",
      "createdAt": "2025-10-24 18:56:42+00:00",
      "updatedAt": "2025-10-24 19:11:50+00:00"
    }
  ]
}

Changes

  • d3054d7412d5Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the /// response's property type changed from no type to string for status

    • breaking

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

    • info

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

    • info

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

  • 7f5e54fa9f05Revision changes
    • info

      endpoint added