Get Service Items List

GET

https://{tenant}.atomicwork.com/api/v1/workspaces/:workspaceId/service-catalog/:categoryId/items

GET

/api/v1/workspaces/:workspaceId/service-catalog/:categoryId/items

$ curl -G https://{tenant}.atomicwork.com/api/v1/workspaces/1/service-catalog/1/items \
>      -H "X-Workspace-Id: 42" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d per_page=25 \
>      -d search_key=email

200Retrieved

1 {
2   "items": [
3     {
4       "id": 101,
5       "name": "Corporate Email Setup",
6       "description": "Provision a new corporate email account with standard access and mailbox size.",
7       "categoryId": 7,
8       "price": 0,
9       "available": true,
10       "createdAt": "2024-05-10T09:30:00Z",
11       "updatedAt": "2024-05-15T12:00:00Z"
12     },
13     {
14       "id": 102,
15       "name": "Email Forwarding Setup",
16       "description": "Configure email forwarding rules for your corporate email account.",
17       "categoryId": 7,
18       "price": 0,
19       "available": true,
20       "createdAt": "2024-04-20T11:00:00Z",
21       "updatedAt": "2024-05-01T08:45:00Z"
22     }
23   ],
24   "page": 1,
25   "per_page": 25,
26   "total_items": 2,
27   "total_pages": 1
28 }

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

workspaceIdlongRequired

The workspace ID

categoryIdlongRequired

The category ID

Query parameters

pageintegerRequired>=1Defaults to 1

per_pageintegerOptional1-100Defaults to 25

search_keystringOptional>=1 character

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response