GET v1/contracts
Retuns the active advertiser contracts
Requires Authorization
To perform authorization, you must submit the authentication credentials using the HTTP Basic authorization header.
The authorization header is constructed as follows:
- The username and password are combined into a string "user:password"
- The resulting literal string is then encoded in Base64
- The authorization method followed by the word "Basic" is then placed before the coded sequence.
Authorization: Basic QWxhZGRpbjpvcGVuLXNlc2FtZQ==
Response Codes
- OK (200)
- BadRequest (400)
- Unauthorized (401)
- Forbidden (403)
- NotFound (404)
Response Information
Resource Description
ContractResponse array Returns a list of the advertiser's contracts.
Name | Description | Type | Additional Information |
---|---|---|---|
Id | Advertiser contract identification code | integer | |
StartsAt | Contract start date (Format DD/MM/YYYY) | string | |
ExpiresAt | Contract expiration date (Format DD/MM/YYYY) | string | |
Status | Current contract status | string | |
HasAdsPlan | Indicates whether the contract has an Ad Plan | boolean | |
HasWebsitePlan | Indicates whether the contract has a private website plan (EmEstoque.com.br) | boolean |
Response Formats
application/json, text/json
Notes:
- In Json format, the parameter names follow the camelCase pattern, that is, they always start with lowercase letters.
[ { "id": 1, "startsAt": "13/09/2025", "expiresAt": "13/10/2025", "status": "Active", "hasAdsPlan": true, "hasWebsitePlan": false }, { "id": 1, "startsAt": "13/09/2025", "expiresAt": "13/10/2025", "status": "Active", "hasAdsPlan": true, "hasWebsitePlan": false } ]
text/html
[{"id":1,"startsAt":"13/09/2025","expiresAt":"13/10/2025","status":"Active","hasAdsPlan":true,"hasWebsitePlan":false},{"id":1,"startsAt":"13/09/2025","expiresAt":"13/10/2025","status":"Active","hasAdsPlan":true,"hasWebsitePlan":false}]
application/xml, text/xml
<ArrayOfContractResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ContractResponse> <Id>1</Id> <StartsAt>13/09/2025</StartsAt> <ExpiresAt>13/10/2025</ExpiresAt> <Status>Active</Status> <HasAdsPlan>true</HasAdsPlan> <HasWebsitePlan>false</HasWebsitePlan> </ContractResponse> <ContractResponse> <Id>1</Id> <StartsAt>13/09/2025</StartsAt> <ExpiresAt>13/10/2025</ExpiresAt> <Status>Active</Status> <HasAdsPlan>true</HasAdsPlan> <HasWebsitePlan>false</HasWebsitePlan> </ContractResponse> </ArrayOfContractResponse>