List services
Scope: sales:services.read https://api.alladdin.com/api/v2/services
Returns a paginated list of services in your catalog.
Results are cursor-paginated. Default page size is 25, configurable up to 100 with limit.
Parameters
Query parameters
limit integer optional = 50
Maximum number of services to return per page. Defaults to 25, maximum 100.
cursor string optional
Pagination cursor returned by the previous response. Omit to start from the first page.
include_archived boolean optional = false
Whether to include archived services in the results
Request
import requests
url = "https://api.alladdin.com/api/v2/services?limit=50&cursor=value&include_archived=false"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"name": "Consulting",
"code": "SRV-001",
"description": "Consulting service",
"price": "100.00",
"cost": "50.00",
"tags": [
"string"
],
"taxes": [
"string"
],
"sales_channel_id": "string",
"color": "string",
"duration": "string",
"archived": false
}
],
"has_more": false,
"cursor": "string"
}Success responses
200 List of services application/json object items[] object[] required id string
Unique identifier of the service
name string
Name of the service
code string
Internal reference code for the service
description string
Description of the service
price string
Sale price as a decimal string
cost string
Cost price as a decimal string
tags[] string[]
List of tags attached to the service
taxes[] string[]
List of tax identifiers applied to the service
sales_channel_id string | null
Identifier of the sales channel assigned to this service
color string | null
Hex color code used in the UI
duration string | null
Duration in minutes as a decimal string
archived boolean
Whether the service is archived
has_more boolean required
Whether there are more items on the next page
cursor string | null optional
Opaque cursor to pass as ?cursor= to fetch the next page. Null on the last page.
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json