Retrieve Contracts

Description

This endpoint allows querying the available contracts/plans, with filtering options by name, branch, update date, among others. It is also possible to include additional information, such as activity groups, online sales observations, and branches with access.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

Parameter	Type	Required	Description
`idMembership`	int	No	Filters by the specific membership ID.
`name`	string	No	Filters by the contract name.
`idBranch`	int	No	Filters by the branch ID. Ignored if the API key is not multi-branch.
`take`	int	No	Total number of records to be returned (maximum: 50). Default: 25.
`skip`	int	No	Number of records to be skipped (for pagination). Default: 0.
`active`	boolean	No	Filters by active or inactive contracts.
`updateDate`	string (ISO)	No	Filters contracts updated from this date (`yyyy-mm-dd`).
`showAccessBranches`	boolean	No	Displays the branches where the contract guarantees access. Default: `false`.
`showOnlineSalesObservation`	boolean	No	Displays observations related to online sales. Default: `false`.
`showActivitiesGroups`	boolean	No	Displays the activity groups linked to the plan/contract. Default: `false`.
`showSuspensionRules`	boolean	No	Displays the suspension rules in the response. Default: `false`.
`showCancellationRules`	boolean	No	Displays the cancellation rules in the response. Default: `false`.
`showContract`	boolean	No	Displays the contract structure in the response. Default: `false`.
`showTurnstiles`	boolean	No	Displays the turnstiles linked to the plan/contract—either directly or via a turnstile group—in the response. Default: `false`.

📤 Response Structure

The response returns the complete data of a plan, including commercial information, billing rules, additional services, activity groups, associated branches, entries, sales pages, and eligibility settings.

Field	Type	Description
`idMembership`	int32	Unique identifier of the plan.
`idBranch`	int32	ID of the branch associated with the plan.
`nameMembership`	string	Name of the plan.
`membershipType`	string	Type of the plan.
`durationType`	string	Type of duration of the plan (e.g., monthly, yearly).
`duration`	int32	Duration of the plan according to the defined type.
`updateDate`	date-time	Date of the last update of the plan.
`value`	number (double)	Value of the plan.
`maxAmountInstallments`	int32	Maximum number of installments allowed.
`description`	string	Detailed description of the plan.
`urlSale`	string (read-only)	Public URL for selling the plan.
`onlineSalesObservations`	string	Observations displayed in the online sales flow.
`differentials`	arrayobject	List of differentials associated with the plan. See more below.
`accessBranches`	arrayobject	List of branches where the plan is valid. See more below.
`additionalService`	arrayobject	Additional service linked to the plan. See more below.
`serviceYearly`	arrayobject	Annual service associated with the plan. See more below.
`typePromotionalPeriod`	int32	Type of promotional period applied to the plan or service, defining the promotion duration rule.
`valuePromotionalPeriod`	number	Value applied during the promotional period.
`monthsPromotionalPeriod`	int32	Number of months of duration of the promotional period, when applicable.
`daysPromotionalPeriod`	int32	Number of days of duration of the promotional period, when applicable.
`minPeriodStayMembership`	int32	Minimum period of stay in the plan.
`installmentsPromotionalPeriod`	int32	Number of installments allowed during the promotional period.
`activitiesGroups`	arrayobject	Activity groups linked to the plan. See more below.
`inactive`	boolean	Indicates if the plan is inactive.
`displayName`	string	Formatted display name of the plan.
`entries`	arrayobject	Configuration of entries allowed by the plan. See more below.
`salesPage`	arrayobject	Sales pages associated with the plan. See more below.
`allowsCancellationByApp`	boolean	Indicates if the plan can be canceled through the app.
`externalSaleAvailable`	boolean	Indicates if the plan can be sold externally.
`acceptEnrollment`	boolean	Indicates if direct enrollment is accepted.
`enrollmentRequired`	boolean	Indicates if mandatory enrollment is required.
`contractSuspension`	arrayobject	Suspension rules linked to the plan. See more below.
`contractCancellation`	arrayobject	Cancellation rules linked to the plan. See more below.
`htmlContract`	string	Contract structure linked to the plan.
`turnstiles`	array	List of turnstiles associated with the plan/contract.

🧩 Structure of `differentials`

Field	Type	Description
`title`	string
`order`	int32

🧩 Structure of `accessBranches`

Field	Type	Description
`idBranch`	int32	Identifier of the branch to which the member has access.
`name`	string	Name of the branch to which the member has access.

🧩 Structure of `additionalService`

Field	Type	Description
`idService`	int32	Identifier of the additional service.
`name`	string	Name of the additional service.
`value`	number	Value of the additional service.

🧩 Structure of `serviceYearly`

Field	Type	Description
`idService`	int32	ID of the annual service.
`name`	string	Name of the annual service.
`value`	number (double)	Value of the annual service.
`type`	int32	Type of billing for the service.
`billingMonth`	int32	Billing month.
`billingDay`	int32	Billing day.
`billingAfterMonths`	int32	Months after contracting for billing.
`installments`	int32	Number of installments.
`typePromotionalPeriod`	int32	Type of promotional period.
`valuePromotionalPeriod`	number (double)	Promotional value.
`monthsPromotionalPeriod`	int32	Number of promotional months.
`daysPromotionalPeriod`	int32	Number of promotional days.
`installmentsPromotionalPeriod`	int32	Installments in the promotional period.

🧩 Structure of `activitiesGroups`

Field	Type	Description
`idGroupActivity`	int32	ID of the activity group.
`name`	string	Name of the activity group.
`idBranch`	int32	ID of the branch associated with the group.

🧩 Structure of `entries`

Field	Type	Description
`entriesQuantity`	int32	Number of entries allowed.
`idEntriesType`	int32	Type of entry configured.
`entriesTypeDescription`	string	Description of the entry type.

🧩 Structure of `salesPage`

Field	Type	Description
`idSalesPage`	int32	ID of the sales page.
`order`	int32	Display order of the plan on the page.
`salesPageDescription`	string	Description of the sales page.

🧩 Structure of `contractSuspension`

Field	Type	Description
`maxSuspensionsAllowed`	int32	Maximum number of suspensions allowed for the contract.
`totalSuspensionDays`	int32	Total number of suspension days allowed for the contract.
`minimumPeriodBeforeSuspensionDays`	int32	Minimum period, in days, before contract suspension is allowed.
`firstSuspensionGracePeriodMonths`	int32	Grace period, in months, for the first contract suspension.
`nextSuspensionsGracePeriodMonths`	int32	Grace period, in months, for subsequent contract suspensions.

🧩 Structure of `contractCancellation`

Field	Type	Description
`considerClosedCompetencyOnCancellation`	boolean	Indicates whether the closed competency should be considered upon cancellation.
`priorNoticeDays`	int32	Number of prior notice days required for cancellation.
`applyPenaltyAutomatically`	boolean	Indicates whether the penalty should be applied automatically upon cancellation.
`penaltyOverRemainingContractValue`	boolean	Indicates whether the penalty should be calculated over the remaining contract value.
`minimumGracePeriodMonths`	int32	Minimum grace period, in months, for applying the cancellation rules.
`penaltyPercentage`	number	Penalty percentage applied upon contract cancellation.

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

🟢200

application/json

Success

Body

Example

[
    {
        "idMembership": 0,
        "idBranch": 0,
        "nameMembership": "string",
        "membershipType": "string",
        "durationType": "string",
        "duration": 0,
        "updateDate": "2019-08-24T14:15:22.123Z",
        "value": 0,
        "maxAmountInstallments": 0,
        "description": "string",
        "urlSale": "string",
        "onlineSalesObservations": "string",
        "differentials": [
            {
                "title": "string",
                "order": 0
            }
        ],
        "accessBranches": [
            {
                "idBranch": 0,
                "name": "string"
            }
        ],
        "additionalService": {
            "idService": 0,
            "name": "string",
            "value": 0
        },
        "serviceYearly": {
            "idService": 0,
            "name": "string",
            "value": 0,
            "type": 0,
            "billingMonth": 0,
            "billingDay": 0,
            "billingAfterMonths": 0,
            "installments": 0
        },
        "typePromotionalPeriod": 0,
        "valuePromotionalPeriod": 0,
        "monthsPromotionalPeriod": 0,
        "daysPromotionalPeriod": 0,
        "minPeriodStayMembership": 0,
        "installmentsPromotionalPeriod": 0,
        "activitiesGroups": [
            {
                "idGroupActivity": 0,
                "name": "string",
                "idBranch": 0
            }
        ],
        "inactive": true,
        "displayName": "string",
        "entries": {
            "entriesQuantity": 0,
            "idEntriesType": 0,
            "entriesTypeDescription": "string"
        },
        "salesPage": [
            {
                "idSalesPage": 0,
                "order": 0,
                "salesPageDescription": "string"
            }
        ],
        "allowsCancellationByApp": true,
        "externalSaleAvailable": true,
        "acceptEnrollment": true,
        "enrollmentRequired": true,
        "contractSuspension": {
            "maxSuspensionsAllowed": 0,
            "totalSuspensionDays": 0,
            "minimumPeriodBeforeSuspensionDays": 0,
            "firstSuspensionGracePeriodMonths": 0,
            "nextSuspensionsGracePeriodMonths": 0
        },
        "contractCancellation": {
            "considerClosedCompetencyOnCancellation": true,
            "priorNoticeDays": 0,
            "applyPenaltyAutomatically": true,
            "penaltyOverRemainingContractValue": true,
            "minimumGracePeriodMonths": 0,
            "penaltyPercentage": 0
        },
        "htmlContract": "string",
        "turnstiles": [
            0
        ]
    }
]

🟠400

Get memberships

Retrieve Contracts#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of differentials#

🧩 Structure of accessBranches#

🧩 Structure of additionalService#

🧩 Structure of serviceYearly#

🧩 Structure of activitiesGroups#

🧩 Structure of entries#

🧩 Structure of salesPage#

🧩 Structure of contractSuspension#

🧩 Structure of contractCancellation#

Request