List Services

Description

Returns the list of services registered in the system, allowing filtering by ID, name, branch, and status (active/inactive). The results can be paginated through the take and skip parameters.

🔑 Query Parameters

Parameter	Type	Required	Description
idService	int32	No	Filter by the specific ID of the service.
name	string	No	Filter by the name of the service.
idBranch	int32	Recommended	Filter by the branch number (only applicable for multi-location keys; ignored otherwise).
showOnlyExternalIntegrationServices	boolean	No	Filter services that allow sales from external integrations.
showActivities	boolean	No	Show activities.
take	int32	No	Number of records to be returned (maximum 50). Default: 25.
skip	int32	No	Number of records to be ignored in the listing (pagination). Default: 0.
active	boolean	No	Filter to return only active services (`true`) or inactive (`false`).

📤 Response Structure

The response returns the list of services found based on the provided filters. Each service object includes information such as name, value, availability for entries, online sale, and commercial observations.

Field	Type	Description
idService	int32	Unique ID of the service.
idBranch	int32	ID of the branch associated with the service.
nameService	string	Name of the service.
value	number	Value of the service.
allowEntries	boolean	Indicates if the service allows entry records.
experimentalClass	boolean	Indicates if the service allows trial classes.
maxAmountInstallments	int32	Maximum number of installments allowed for the sale of the service.
urlSale	string	URL for selling the service online.
inactive	boolean	Indicates if the service is inactive (`true`) or active (`false`).
onlineSalesObservations	string	Additional observations about the online sale of the service.
allowsUseoftheServiceinExternalIntegration	boolean	Indicates if the service allows external integrations for sales.
needConferenceAvailabilityScheduling	boolean	Indicates if the service needs availability conference for scheduling.
activityGroups	arrayobject	Activity group. See more below.
activityGroupsToSerialize	arrayobject	Activity group to serialize. See more below.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "idService": 0,
        "idBranch": 0,
        "nameService": "string",
        "value": 0,
        "allowEntries": true,
        "experimentalClass": true,
        "maxAmountInstallments": 0,
        "urlSale": "string",
        "inactive": true,
        "onlineSalesObservations": "string",
        "allowsUseoftheServiceinExternalIntegration": true,
        "needConferenceAvailabilityScheduling": true,
        "activityGroups": [
            {
                "idActivityGroup": 0,
                "nameActivityGroup": "string"
            }
        ]
    }
]

🟠400Bad Request

Get services

List Services#

Description#

🔑 Query Parameters#