List services
GET {{baseUrl}}/services?name=<string>,<string>&type=background_worker,cron_job&env=go,ruby®ion=frankfurt,oregon&suspended=suspended,suspended&createdBefore=<dateTime>&createdAfter=<dateTime>&updatedBefore=<dateTime>&updatedAfter=<dateTime>&ownerId=<string>,<string>&cursor=<string>&limit=20
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | string | Filter for the names of services | |
type | string | Filter for types of services | |
env | string | Filter for environments (runtimes) of services | |
region | string | Filter for regions of services | |
suspended | string | Filter services based on whether they're suspended or not suspended | |
createdBefore | string | Filter for services created before a certain time (specified as an ISO 8601 timestamp) | |
createdAfter | string | Filter for services created after a certain time (specified as an ISO 8601 timestamp) | |
updatedBefore | string | Filter for services updated before a certain time (specified as an ISO 8601 timestamp) | |
updatedAfter | string | Filter for services updated after a certain time (specified as an ISO 8601 timestamp) | |
ownerId | string | The ID of the owner (team or personal user) whose resources should be returned | |
cursor | string | Cursor to begin retrieving entries for this query | |
limit | number | Max number of items that can be returned |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"service":{"id":"\u003cstring\u003e","autoDeploy":"yes","branch":"\u003cstring\u003e","buildFilter":{"paths":["\u003cstring\u003e","\u003cstring\u003e"],"ignoredPaths":["\u003cstring\u003e","\u003cstring\u003e"]},"createdAt":"\u003cdateTime\u003e","image":{"imagePath":"\u003cstring\u003e","ownerId":"\u003cstring\u003e","registryCredentialId":"\u003cstring\u003e"},"name":"\u003cstring\u003e","notifyOnFail":"notify","ownerId":"\u003cstring\u003e","repo":"\u003cstring\u003e","rootDir":"\u003cstring\u003e","slug":"\u003cstring\u003e","suspended":"not_suspended","suspenders":["admin","unknown"],"type":"web_service","updatedAt":"\u003cdateTime\u003e","serviceDetails":{"buildCommand":"\u003cstring\u003e","parentServer":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"publishPath":"\u003cstring\u003e","pullRequestPreviewsEnabled":"yes","url":"\u003cstring\u003e"}},"cursor":"\u003cstring\u003e"},{"service":{"id":"\u003cstring\u003e","autoDeploy":"yes","branch":"\u003cstring\u003e","buildFilter":{"paths":["\u003cstring\u003e","\u003cstring\u003e"],"ignoredPaths":["\u003cstring\u003e","\u003cstring\u003e"]},"createdAt":"\u003cdateTime\u003e","image":{"imagePath":"\u003cstring\u003e","ownerId":"\u003cstring\u003e","registryCredentialId":"\u003cstring\u003e"},"name":"\u003cstring\u003e","notifyOnFail":"default","ownerId":"\u003cstring\u003e","repo":"\u003cstring\u003e","rootDir":"\u003cstring\u003e","slug":"\u003cstring\u003e","suspended":"not_suspended","suspenders":["admin","parent_service"],"type":"web_service","updatedAt":"\u003cdateTime\u003e","serviceDetails":{"buildCommand":"\u003cstring\u003e","parentServer":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"publishPath":"\u003cstring\u003e","pullRequestPreviewsEnabled":"yes","url":"\u003cstring\u003e"}},"cursor":"\u003cstring\u003e"}]