Get catalogue item

GET

https://{tenant}.atomicwork.com/api/v1/workspaces/:workspaceId/catalogue/items

GET

/api/v1/workspaces/:workspaceId/catalogue/items

$ curl -G https://{tenant}.atomicwork.com/api/v1/workspaces/1/catalogue/items \
>      -H "X-Workspace-Id: 42" \
>      -H "X-Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d category_type=SERVICE_REQUEST \
>      -d per_page=25 \
>      --data-urlencode "search_key=email setup" \
>      -d category_id=101 \
>      -d is_published=true

200Retrieved

1 {
2   "items": [
3     {
4       "id": 1001,
5       "name": "Corporate Email Account Setup",
6       "description": "Request to set up a new corporate email account for employees.",
7       "category_id": 101,
8       "category_type": "SERVICE_REQUEST",
9       "is_published": true,
10       "created_at": "2024-05-10T09:15:00Z",
11       "updated_at": "2024-05-15T12:00:00Z"
12     },
13     {
14       "id": 1002,
15       "name": "Email Forwarding Configuration",
16       "description": "Service to configure email forwarding rules for your account.",
17       "category_id": 101,
18       "category_type": "SERVICE_REQUEST",
19       "is_published": true,
20       "created_at": "2024-04-20T11:30:00Z",
21       "updated_at": "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

Query parameters

pageintegerRequired>=1Defaults to 1

per_pageintegerOptional1-1000Defaults to 25

search_keystringOptional>=1 character

category_idlongOptional

category_typeenumOptional

Allowed values:

is_publishedbooleanOptional

Response

Successful response

Authentication

Path parameters

Headers

Query parameters

Response