List all services of a project

Request

Retrieve a list of voice services in the specified project.

Optionally:

Filter services by partial match on name or description (filter)
Return only the default service (default=true)

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

Query

filterstring

Filter services by name or description. Returns all services where either the name or description contains the specified value (case-insensitive partial match).

isDefaultboolean

Return the default service only.

Example:isDefault=true

pageSizeinteger, [ 1 .. 100 ]

Number of items to be returned on each page.

Default:20

pageinteger, >= 1

Page number (1-based)

Default:1

curl -i -X GET \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/services?filter=string&isDefault=true&pageSize=20&page=1'

Responses

A list of services.

Bodyapplication/json

servicesArray of objects(Service Information)required

linksobject(Pagination Links)required

Pagination links for navigating through pages of results in a paginated list response.

Available link properties:

first - Absolute URI of the first page
last - Absolute URI of the last page
next - Absolute URI of the next page (omitted if this is the last page)
prev - Absolute URI of the previous page (omitted if this is the first page)
self - Absolute URI of the current page

metaobject(Pagination Metadata)required

Metadata about the paginated list response.

Response

{
  "services": [
    { … },
    { … }
  ],
  "links": {
    "first": "https://voice.api.sinch.com/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/services?page=1&pageSize=20",
    "last": "https://voice.api.sinch.com/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/services?page=1&pageSize=20",
    "self": "https://voice.api.sinch.com/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/services?page=1&pageSize=20"
  },
  "meta": {
    "totalCount": 2,
    "pageCount": 1
  }
}

We'd love to hear from you!