mamut-api (1.0.0)

Download OpenAPI specification:

MamutTV API. Errors are returned as application/problem+json.

Authentication

Sign-in, token refresh and device session flow

Sign in to the dashboard with a Turnstile token

The Turnstile token goes either in the X-Turnstile-Token header or in the cf-turnstile-response body field

header Parameters

X-Turnstile-Token	string
CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

cf-turnstile-response	string
email required	string <email>
password required	string

Responses

Request samples

Payload

Content type

application/json

{"cf-turnstile-response": "string",
"email": "user@example.com",
"password": "string"
}

Response samples

Content type

application/json

{"accessToken": "9018c41a-c414-471c-8b50-f5169f6e6f64",
"refreshToken": "9018c41a-c414-471c-8b50-f5169f6e6f64"
}

Sign up with a Turnstile token

The Turnstile token goes either in the X-Turnstile-Token header or in the cf-turnstile-response body field

header Parameters

X-Turnstile-Token	string
CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

cf-turnstile-response	string
email required	string <email>
name required	string
password required	string [ 12 .. 72 ] characters

Responses

Request samples

Payload

Content type

application/json

{"cf-turnstile-response": "string",
"email": "user@example.com",
"name": "string",
"password": "stringstring"
}

Response samples

Content type

application/json

{"message": "Conta criada com sucesso. Enviamos um link de verificacao para o seu e-mail."
}

Generate a single-use sign-in code

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"uniqueCode": "string"
}

Get the authenticated user

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"address": {"address1": "Rua Moura",
"address2": "Ap. 601",
"city": "São José",
"number": "270",
"state": "SC",
"zipCode": "88117250"
},
"createdAt": "2024-01-03T18:17:52.838Z",
"document": {"type": "CPF",
"value": "40652029060"
},
"email": "john@doe.com",
"entitlement": "active",
"freeTrial": {"endsAt": "2024-01-10T18:17:52.838Z",
"status": "active"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mainProfileId": "98ae0467-8b93-46a4-9ab0-aafff34c7be6",
"name": "John",
"notifyNewEpisodeEmail": false,
"phone": "+5548991148203",
"profiles": [{"avatar": "string",
"createdAt": "2024-01-03T18:17:52.838Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isKids": false,
"name": "John Doe",
"parentalControl": false,
"updatedAt": "2024-01-03T18:17:52.838Z",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
],
"status": "ACTIVE",
"updatedAt": "2024-01-03T18:17:52.838Z"
}

Refresh the access token

Request Body schema: application/json
required

accessToken required	string non-empty
refreshToken required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"accessToken": "string",
"refreshToken": "string"
}

Response samples

Content type

application/json

{"accessToken": "9018c41a-c414-471c-8b50-f5169f6e6f64",
"refreshToken": "9018c41a-c414-471c-8b50-f5169f6e6f64"
}

Create a device login session

Request Body schema: application/json

deviceUuid

string <= 128 characters

Responses

Request samples

Payload

Content type

application/json

{"deviceUuid": "a3f1c0de-1234-5678-9abc-def012345678"
}

Response samples

201
415
422
500

Content type

application/json

{"deviceCode": "string",
"expiresIn": 480,
"interval": 5,
"slotCheckSupported": true,
"status": "string",
"userCode": "string"
}

Check the status of a device session code

Polled by the device with the device_code it received when the pairing started. While the user has not approved yet, answers 400 with error=authorization_pending: keep polling, respecting the interval from the pairing response. Once the code dies, answers 400 with error=expired_token: stop polling and start a new pairing. Error codes follow RFC 8628 section 3.5. The user_code shown on screen is not accepted here: it is meant to be read out loud.

Request Body schema: application/json
required

deviceCode

required

string [ 1 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

{"deviceCode": "0192f0c3-6f9e-7a1b-9c2d-3e4f5a6b7c8d"
}

Response samples

200
400
415
422
500

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"status": "approved",
"userCode": "12345678"
}

Approve a pending device session

Authorizations:

bearerAuth

Request Body schema: application/json
required

subscriptionId	string <uuid>
userCode required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"userCode": "string"
}

Response samples

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"deviceCode": "9018c41a-c414-471c-8b50-f5169f6e6f64",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"status": "approved",
"userCode": "12345678"
}

Sign in with email and password

Request Body schema: application/json
required

email required	string <email>
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "string"
}

Response samples

Content type

application/json

{"accessToken": "9018c41a-c414-471c-8b50-f5169f6e6f64",
"refreshToken": "9018c41a-c414-471c-8b50-f5169f6e6f64"
}

Sign in with a Google account

Request Body schema: application/json
required

credential

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"credential": "string"
}

Response samples

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

Sign in with a single-use code

Request Body schema: application/json
required

uniqueCode

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"uniqueCode": "string"
}

Response samples

Content type

application/json

{"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

Email verification

Address verification and email change confirmation

Confirm a pending email change

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

token

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

Content type

application/json

{"message": "E-mail alterado com sucesso."
}

Request a new email verification link

Request Body schema: application/json
required

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

400
415
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Cancel a pending email change or revert a confirmed one

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

token

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

Content type

application/json

{"message": "Solicitacao cancelada. Sua conta segue com o e-mail atual."
}

Verify the account email

query Parameters

token

required

string

Responses

Response samples

200
400
404
422
500

Content type

application/json

{"message": "E-mail verificado com sucesso."
}

Request a change of the account email

Authorizations:

bearerAuth

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

newEmail required	string <email>
password required	string

Responses

Request samples

Payload

Content type

application/json

{"newEmail": "new@doe.com",
"password": "string"
}

Response samples

Content type

application/json

{"message": "Enviamos um link de confirmacao para o novo e-mail."
}

Account

Account data, password recovery and profile PIN

Delete the authenticated user's account

Authorizations:

bearerAuth

Request Body schema: application/json
required

password

required

string <= 72 characters

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Update the authenticated user account

Partial update: only non-empty fields are applied, and the address is only applied when zipCode is present.

Authorizations:

bearerAuth

Request Body schema: application/json
required

	object (CommandAddressStruct)
	object (CommandDocumentStruct)
mainProfileId	string <uuid>
name	string
notifyNewEpisodeEmail	boolean
phone	string

Responses

Request samples

Payload

Content type

application/json

{"address": {"address1": "Rua Moura",
"address2": "Ap. 601",
"city": "São José",
"number": "270",
"state": "SC",
"zipCode": "88117250"
},
"document": {"type": "CPF",
"value": "40652029060"
},
"mainProfileId": "98ae0467-8b93-46a4-9ab0-aafff34c7be6",
"name": "John",
"notifyNewEpisodeEmail": true,
"phone": "+5548991148203"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Change the password of the authenticated user

Authorizations:

bearerAuth

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

actualPassword required	string
confirmNewPassword required	string [ 12 .. 72 ] characters
newPassword required	string [ 12 .. 72 ] characters

Responses

Request samples

Payload

Content type

application/json

{"actualPassword": "string",
"confirmNewPassword": "stringstring",
"newPassword": "stringstring"
}

Response samples

400
401
415
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Request a password recovery code by email

Always answers 202, whether or not the email is registered.

Request Body schema: application/json
required

email

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com"
}

Response samples

415
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Reset the password with a recovery code

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

code required	string non-empty
newPassword required	string [ 12 .. 72 ] characters

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"newPassword": "stringstring"
}

Response samples

400
415
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Profiles

Viewer profiles of an account

Create a profile

Authorizations:

bearerAuth

Request Body schema: application/json
required

file required	string
isKids	boolean
layout	string
name required	string

Responses

Request samples

Payload

Content type

application/json

{"file": "images/avatar-1.png",
"isKids": false,
"layout": "elegant",
"name": "Test"
}

Response samples

Content type

application/json

{"avatar": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isKids": true,
"layout": "string",
"name": "string",
"parentalControl": true,
"updatedAt": "2019-08-24T14:15:22Z",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Delete a profile

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
409
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Get a profile by id

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"avatar": "string",
"createdAt": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isKids": false,
"layout": "string",
"name": "string",
"parentalControl": {"active": true
},
"updatedAt": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Update a profile

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

file	string
isKids	boolean
layout	string
name	string
	object (EditProfileParentalControlPatch)

Responses

Request samples

Payload

Content type

application/json

{"file": "images/avatar-1.png",
"isKids": false,
"layout": "elegant",
"name": "Test",
"parentalControl": {"active": true,
"actualPassword": "1234",
"change": true,
"confirmPassword": "new.password",
"password": "new.password"
}
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Send a link to redefine a profile parental control PIN

Mails a single-use link to the account address. The PIN itself is never sent.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Responses

Response samples

401
404
409
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Redefine a profile parental control PIN with a reset token

Consumes the single-use token from the reset e-mail and stores the new PIN. The current PIN is not required.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

confirmPin required	string [ 1 .. 32 ] characters
pin required	string [ 1 .. 32 ] characters
token required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"confirmPin": "1234",
"pin": "1234",
"token": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Check a profile parental control PIN

Answers whether the PIN matches. The PIN itself is never returned by any endpoint.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

required

string [ 1 .. 32 ] characters

Responses

Request samples

Payload

Content type

application/json

{"pin": "1234"
}

Response samples

Content type

application/json

{"valid": true
}

Sessions

Active sessions and device info

List the user's sessions

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"sessions": [{"city": "string",
"country": "string",
"deviceInfo": "string",
"deviceName": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ip": "string",
"isMobile": true,
"lastAccess": "2019-08-24T14:15:22Z",
"lastActivity": "string",
"loc": "string",
"org": "string",
"region": "string",
"timezone": "string"
}
]
}

Log out a session

Authorizations:

bearerAuth

path Parameters

sessionId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List the subscriptions a device can sign in through

Answers, for one device, which subscriptions still have a free seat and whether that device already occupies one. Read requiresSelection to know if there is still a choice to make: a device that already holds a seat signs in through that same subscription.

Two flows reach this route. With userCode, the caller is the approving phone and the device is the one waiting on that pairing — deviceUuid is ignored. Without userCode, the caller is the device itself signing in by e-mail, and it identifies itself through deviceUuid, falling back to the device already recorded on the caller's own session.

Authorizations:

bearerAuth

query Parameters

userCode	string <= 64 characters Examples: userCode=12345678
deviceUuid	string <= 128 characters Examples: deviceUuid=a3f1c0de-1234-5678-9abc-def012345678

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"deviceKnown": true,
"requiresSelection": false,
"subscriptions": [{"availableSlots": 1,
"deviceAlreadyBound": false,
"eligible": true,
"licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
"planCategory": "family",
"reason": "slot_available",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"totalSlots": 4,
"usedSlots": 3
}
]
}

Update the device info of the current session

Authorizations:

bearerAuth

header Parameters

Authorization	string
CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

city	string
country	string
deviceInfo	string
deviceModel	string
deviceUuid	string
ip	string
isMobile	boolean
loc	string
macAddress	string
org	string
region	string
timezone	string

Responses

Request samples

Payload

Content type

application/json

{"city": "string",
"country": "string",
"deviceInfo": "string",
"deviceModel": "string",
"deviceUuid": "string",
"ip": "string",
"isMobile": true,
"loc": "string",
"macAddress": "string",
"org": "string",
"region": "string",
"timezone": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Select the subscription of the current session

Sets the subscription of the current session. A device never changes subscription on request: when the session's device already holds a seat on another subscription, responds 409 and nothing changes. The seat is freed only from the account panel, through DELETE /api/v1/user/licenses/{licenseId}/device, and only on plans that allow changing the device.

Authorizations:

bearerAuth

Request Body schema: application/json
required

subscriptionId

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

Response samples

Content type

application/json

{"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

Licenses

Seats bound to devices

List individual plan licenses

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"licenses": [{"bound": true,
"city": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceId": "string",
"deviceInfo": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ip": "string",
"isMobile": true,
"lastAccess": "2019-08-24T14:15:22Z",
"loc": "string",
"org": "string",
"region": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"timezone": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

List family plan licenses

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"licenses": [{"bound": true,
"city": "string",
"country": "string",
"createdAt": "2019-08-24T14:15:22Z",
"deviceId": "string",
"deviceInfo": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"ip": "string",
"isMobile": true,
"lastAccess": "2019-08-24T14:15:22Z",
"loc": "string",
"org": "string",
"region": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"timezone": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Unbind the device from a license

Frees the license's seat and signs its device out. Only per-device plus and family plans allow changing the device: on a per-device plan responds 403 and the device stays bound.

Authorizations:

bearerAuth

path Parameters

licenseId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
403
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Family

Family plan seats and invitations

Invite a member to a family plan seat

Authorizations:

bearerAuth

Request Body schema: application/json
required

invitedEmail

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"invitedEmail": "user@example.com"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Accept a family plan invite

Authorizations:

bearerAuth

Request Body schema: application/json
required

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Preview a family plan invite by token

query Parameters

token

required

string

Responses

Response samples

200
404
422
500

Content type

application/json

{"expiresAt": "2019-08-24T14:15:22Z",
"ownerFirstName": "string"
}

Cancel a pending family plan invite

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Resend a pending family plan invite

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Remove a member from a family plan seat

Authorizations:

bearerAuth

path Parameters

licenseId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
409
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Get the family plan the caller belongs to as a member

Returns the family subscription of another account in which the caller occupies a seat. The owner of a family plan is not a member of it and receives 404, as does anyone without a seat in a family subscription that currently allows content.

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"cancelAtPeriodEnd": true,
"ownerFirstName": "string",
"planExpiresAt": "2019-08-24T14:15:22Z",
"status": "active",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

List the seats of the caller's family plan

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500

Content type

application/json

{"slots": [{"deviceName": "string",
"licenseId": "be894337-ec7c-4bdc-ac72-f939e31237ae",
"memberName": "string",
"occupant": "string",
"pendingInvite": {"expiresAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"invitedEmail": "string",
"resendCount": 0
}
}
],
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"totalSlots": 0
}

Rename a family plan seat's device

Authorizations:

bearerAuth

path Parameters

licenseId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

name

required

string [ 1 .. 50 ] characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Billing

Plans, subscription, payment methods and invoices

Cancel the subscription

The subscription stays active until the end of the current billing period.

Authorizations:

bearerAuth

Request Body schema: application/json
required

subscriptionId

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Create a checkout session

Authorizations:

bearerAuth

Request Body schema: application/json
required

screens_quantity required	integer <int64> >= 1 Quantidade comprada no Stripe, não o número de vagas. individual: uma por tela; individual_plus: pacotes, sempre 1 (o pacote dá 4 vagas); family: uma por tela, a partir de 3.
stripe_plan_id required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"screens_quantity": 1,
"stripe_plan_id": "string"
}

Response samples

Content type

application/json

{"checkoutSession": {"id": "string",
"status": "string",
"url": "string"
}
}

Set the default payment method

Authorizations:

bearerAuth

Request Body schema: application/json
required

payment_method_id

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"payment_method_id": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List the invoice history

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500
502

Content type

application/json

{"invoices": [{"amountPaid": 0,
"currency": "string",
"id": "string",
"paidAt": 0,
"periodEnd": 0,
"periodStart": 0,
"status": "string"
}
]
}

List saved payment methods

Authorizations:

bearerAuth

Responses

Response samples

200
401
404
500
502

Content type

application/json

{"payment_methods": [{"brand": "string",
"exp_month": 0,
"exp_year": 0,
"id": "string",
"is_default": true,
"last4": "string"
}
]
}

Add a payment method

Authorizations:

bearerAuth

Request Body schema: application/json
required

payment_method_id

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"payment_method_id": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Remove a payment method

Authorizations:

bearerAuth

path Parameters

id

required

string non-empty

Responses

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List plans by category

Authorizations:

bearerAuth

query Parameters

category required	string Enum: "individual" "family" "individual_plus"
lang	string Default: "pt" Enum: "pt" "en" "es"

Responses

Response samples

200
401
422
500
502

Content type

application/json

{"plan_options": [{"description": "string",
"name": "string",
"price": 0,
"stripe_id": "string",
"stripe_price_id": "string",
"years": "string"
}
]
}

Get a plan by ID

Authorizations:

bearerAuth

path Parameters

stripe_id

required

string non-empty

query Parameters

screens_quantity required	integer <int64> >= 1 Quantidade comprada no Stripe, não o número de vagas. individual: uma por tela; individual_plus: pacotes, sempre 1 (o pacote dá 4 vagas); family: uma por tela, a partir de 3.
lang	string Default: "pt" Enum: "pt" "en" "es"

Responses

Response samples

Content type

application/json

{"plan": {"description": "string",
"discount_percentage_applied": 0,
"name": "string",
"price": 0,
"price_without_discount": 0,
"screens_quantity": 0,
"stripe_id": "string",
"stripe_price_id": "string",
"total_with_discount": 0,
"years": "string"
}
}

List the account subscriptions

Authorizations:

bearerAuth

Responses

Response samples

200
401
500
502

Content type

application/json

[{"cancelAtPeriodEnd": true,
"canceledAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"paymentStatus": "string",
"planCategory": "individual",
"planDetails": {"description": "string",
"is_partner": true,
"name": "string",
"price": 0,
"stripe_id": "string",
"stripe_price_id": "string",
"years": "string"
},
"planExpiresAt": "2019-08-24T14:15:22Z",
"resellerName": "string",
"screensQuantity": 0,
"source": "stripe",
"status": "string",
"stripeCheckoutSessionId": "string",
"stripeCustomerId": "string",
"stripePlanId": "string",
"stripeSubscriptionId": "string",
"totalPaid": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
]

Change the subscription plan

The plan change is prorated and invoiced immediately.

Authorizations:

bearerAuth

Request Body schema: application/json
required

planId required	string non-empty
subscriptionId required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"planId": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Activate the free trial

Authorizations:

bearerAuth

Responses

Response samples

200
401
409
500

Content type

application/json

{"endsAt": "2024-01-10T18:17:52.838Z",
"message": "free trial activated"
}

Webhooks

Inbound calls from payment providers

Playlists

Playlist management

List the user's playlists

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

[{"backupPlaylistId": "7991fa44-7417-4104-81b6-35cef8b9fc02",
"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"managedBy": {"kind": "reseller",
"name": "string"
},
"name": "string",
"protected": true,
"providerBlocked": true,
"providerID": "string",
"providerLabel": "string",
"providerStatus": "string",
"routes": [{"baseUrl": "string",
"dnsId": "be7a56a3-552d-4cda-a1bb-1c2299dd5f2a",
"position": 0
}
],
"status": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
]

Create a playlist

Authorizations:

bearerAuth

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

name	string
pin	string <= 64 characters
protected	boolean
providerID	string
url required	string <uri> non-empty

Responses

Request samples

Payload

Content type

application/json

{"name": "Test",
"pin": "string",
"protected": true,
"providerID": "string",
"url": "http://example.com"
}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"protected": true,
"providerID": "string",
"status": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"url": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Delete a playlist

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json

pin	string <= 64 characters Current PIN. Required when the playlist is protected.

Responses

Request samples

Payload

Content type

application/json

{"pin": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Update a playlist

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

currentPin	string <= 64 characters Current PIN. Required when the playlist is protected.
name required	string
pin	string <= 64 characters New PIN. Empty keeps the current one on a protected playlist.
protected	boolean
providerID	string
url required	string

Responses

Request samples

Payload

Content type

application/json

{"currentPin": "string",
"name": "string",
"pin": "string",
"protected": true,
"providerID": "string",
"url": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Send a link to redefine a playlist PIN

Mails a single-use link to the account address. The PIN itself is never sent.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

Responses

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Redefine a playlist PIN with a reset token

Consumes the single-use token from the reset e-mail and stores the new PIN. The current PIN is not required.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

header Parameters

CF-Connecting-IP	string
X-Forwarded-For	string

Request Body schema: application/json
required

confirmPin required	string [ 1 .. 64 ] characters
pin required	string [ 1 .. 64 ] characters
token required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"confirmPin": "1234",
"pin": "1234",
"token": "string"
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Get a profile's source selection

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"activeSource": {"playlistId": "string",
"providerId": "string"
},
"join": {"channels": true,
"movies": true,
"series": true
},
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"resolved": {"channels": ["string"
],
"media": ["string"
],
"movies": ["string"
],
"series": ["string"
]
},
"selection": {"property1": {"channels": true,
"movies": true,
"series": true
},
"property2": {"channels": true,
"movies": true,
"series": true
}
},
"sources": [{"blocked": true,
"name": "string",
"playlistId": "string",
"providerId": "string",
"routes": [{"baseUrl": "string",
"dnsId": "be7a56a3-552d-4cda-a1bb-1c2299dd5f2a",
"position": 0
}
],
"status": "online",
"url": "string"
}
],
"version": 0
}

Set a profile's source selection

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

activeProviderId required	string non-empty
required	object (SourceSelectionJoinFlags)
required	object

Responses

Request samples

Payload

Content type

application/json

{"activeProviderId": "string",
"join": {"channels": true,
"movies": true,
"series": true
},
"selection": {"property1": {"channels": true,
"movies": true,
"series": true
},
"property2": {"channels": true,
"movies": true,
"series": true
}
}
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Favorites

Favorite channels, movies and lists

Create a favorites list

Authorizations:

bearerAuth

Request Body schema: application/json
required

description	string
name	string
profileId	string <uuid>
type	string Enum: "default" "favorites" "import"

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"type": "default"
}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"type": "string"
}

Remove a content from the profile favorites

Authorizations:

bearerAuth

query Parameters

profileId required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
kind required	string Enum: "movie" "tv" "channel"
tmdbId	string
contentId	string
favoritesListId	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List the profile favorites, optionally filtered by kind and list

Authorizations:

bearerAuth

query Parameters

profileId required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
favoritesListId	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
kind	string Enum: "movie" "tv" "channel"

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"favorites": [{"contentId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"favoritesListId": "b04c9441-7dc4-4f87-90e3-43be465e4a99",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"posterPath": "string",
"title": "string",
"tmdbId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Add a content to the profile favorites

Authorizations:

bearerAuth

Request Body schema: application/json
required

contentId	string
favoritesListId	string <uuid>
kind required	string Enum: "movie" "tv" "channel"
posterPath	string <= 500 characters
profileId required	string <uuid>
title	string <= 500 characters
tmdbId	string

Responses

Request samples

Payload

Content type

application/json

{"contentId": "string",
"favoritesListId": "b04c9441-7dc4-4f87-90e3-43be465e4a99",
"kind": "movie",
"posterPath": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"title": "string",
"tmdbId": "string"
}

Response samples

Content type

application/json

{"contentId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"favoritesListId": "b04c9441-7dc4-4f87-90e3-43be465e4a99",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"posterPath": "string",
"title": "string",
"tmdbId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

List the favorites lists of a profile

Authorizations:

bearerAuth

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"favoritesLists": [{"created_at": "2019-08-24T14:15:22Z",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete a favorites list

Authorizations:

bearerAuth

path Parameters

favoritesListId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Fill the display snapshot of a favorite

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

posterPath	string <= 500 characters
profileId required	string <uuid>
title	string <= 500 characters

Responses

Request samples

Payload

Content type

application/json

{"posterPath": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"title": "string"
}

Response samples

Content type

application/json

{"contentId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"favoritesListId": "b04c9441-7dc4-4f87-90e3-43be465e4a99",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"posterPath": "string",
"title": "string",
"tmdbId": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

Content ratings

Per-user content ratings

List content ratings

Authorizations:

bearerAuth

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

200
401
404
422
500

Content type

application/json

[{"contentId": "external-123",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "tv_series",
"rating": 5,
"title": "Breaking Bad",
"tmdbId": "1396"
}
]

Add a content rating

Authorizations:

bearerAuth

Request Body schema: application/json
required

contentId required	string
kind	string
profileId required	string <uuid>
rating required	integer <int64> [ 1 .. 10 ]
title required	string
tmdbId required	string

Responses

Request samples

Payload

Content type

application/json

{"contentId": "string",
"kind": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"rating": 1,
"title": "string",
"tmdbId": "string"
}

Response samples

Content type

application/json

{"contentId": "external-123",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "tv_series",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"rating": 5,
"title": "Breaking Bad",
"tmdbId": "1396"
}

Delete a content rating

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Update a content rating

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

contentId required	string
kind	string
profileId required	string <uuid>
rating required	integer <int64> [ 1 .. 10 ]
title required	string
tmdbId required	string

Responses

Request samples

Payload

Content type

application/json

{"contentId": "string",
"kind": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"rating": 1,
"title": "string",
"tmdbId": "string"
}

Response samples

Content type

application/json

{"contentId": "external-123",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "tv_series",
"rating": 5,
"title": "Breaking Bad",
"tmdbId": "1396"
}

Viewing

Watch progress, watched content and access history

Unfollow a tv series

identityKey is opaque to the client: the list endpoint returns it, this one takes it back. It travels in query and not in path because a ct: key carries the raw title, spaces and slashes included.

Authorizations:

bearerAuth

query Parameters

profileId required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
identityKey required	string [ 1 .. 255 ] characters

Responses

Response samples

400
401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List the tv series a profile follows

Authorizations:

bearerAuth

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/json

{"series": [{"createdAt": "2019-08-24T14:15:22Z",
"fromEpisode": 0,
"fromSeason": 0,
"hasNewEpisode": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityKey": "string",
"lastEpisode": 0,
"lastSeason": 0,
"mediaId": "string",
"newCount": 0,
"newEpisode": 0,
"newSeason": 0,
"notifiedAt": "2019-08-24T14:15:22Z",
"poster": "string",
"title": "string"
}
]
}

Follow a tv series

Authorizations:

bearerAuth

Request Body schema: application/json
required

mediaId required	string [ 1 .. 255 ] characters
profileId required	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"mediaId": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a"
}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityKey": "string",
"lastEpisode": 0,
"lastSeason": 0,
"mediaId": "string",
"poster": "string",
"title": "string"
}

List the access history of a profile

Authorizations:

bearerAuth

query Parameters

id required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
page	integer <int64> >= 1 Default: 1
pageSize	integer <int64> [ 1 .. 100 ] Default: 30

Responses

Response samples

200
401
404
422
500

Content type

application/json

{"histories": [{"accessed_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"media_id": "string",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"tmdb_id": 0
}
]
}

Add a media item to the access history

Returns 201 on the first access to the media item and 200 when an existing entry is refreshed.

Authorizations:

bearerAuth

Request Body schema: application/json
required

kind required	string [ 1 .. 50 ] characters
media_id required	string non-empty
profile_id required	string <uuid>
tmdb_id required	integer <int64> >= 1

Responses

Request samples

Payload

Content type

application/json

{"kind": "string",
"media_id": "string",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"tmdb_id": 1
}

Response samples

Content type

application/json

{"accessed_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "string",
"media_id": "string",
"profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
"tmdb_id": 0
}

Save the watching progress of a content title

Returns 201 with a Location header when the entry is created and 200 when an existing entry is updated.

Authorizations:

bearerAuth

Request Body schema: application/json
required

elapsedTimeMs required	integer <int64> >= 1
episode	integer <int64> >= 0
fullyElapsed	boolean
mediaId required	string [ 1 .. 255 ] characters
profileId required	string <uuid>
season	integer <int64> >= 0
sourceId	string <= 255 characters
totalTimeMs required	integer <int64> >= 1

Responses

Request samples

Payload

Content type

application/json

{"elapsedTimeMs": 1,
"episode": 0,
"fullyElapsed": true,
"mediaId": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"season": 0,
"sourceId": "string",
"totalTimeMs": 1
}

Response samples

Content type

application/json

{"contentTitle": "string",
"elapsedTimeMs": 0,
"episode": 0,
"fullyElapsed": true,
"haveNextEpisode": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityKey": "string",
"kind": "string",
"mediaId": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"season": 0,
"sourceId": "string",
"tmdbId": 0,
"totalTimeMs": 0
}

Remove a title from the continue watching shelf

Deletes every episode entry of the title. identity_key is opaque to the client: the list endpoint returns it, this one takes it back.

Authorizations:

bearerAuth

path Parameters

profile_id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

query Parameters

identity_key

required

string non-empty

Responses

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

List watching progress for a profile

Without query params, returns the most recent entry per title. With media_id, returns every episode of that media. With watched=true, only fully watched entries.

Authorizations:

bearerAuth

path Parameters

profile_id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

query Parameters

page	integer <int64> >= 1 Default: 1
pageSize	integer <int64> [ 1 .. 100 ] Default: 10
media_id	string
watched	boolean

Responses

Response samples

Content type

application/json

{"items": [{"backdropPath": "string",
"elapsedTimeMs": 0,
"episode": 0,
"fullyElapsed": true,
"haveNextEpisode": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityKey": "string",
"inProduction": true,
"kind": "string",
"logoPath": "string",
"mediaId": "string",
"notifiedAt": "2019-08-24T14:15:22Z",
"posterPath": "string",
"releaseDate": "string",
"season": 0,
"sourceId": "string",
"title": "string",
"tmdbId": 0,
"totalTimeMs": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"voteAverage": 0.1
}
],
"page": 0,
"pageSize": 0,
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a"
}

Delete a watching progress entry

Authorizations:

bearerAuth

path Parameters

profile_id required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
id required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

Get a watching progress entry

Authorizations:

bearerAuth

path Parameters

profile_id required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
id required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/json

{"contentTitle": "string",
"createdAt": "2019-08-24T14:15:22Z",
"elapsedTimeMs": 0,
"episode": 0,
"fullyElapsed": true,
"haveNextEpisode": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identityKey": "string",
"kind": "string",
"mediaId": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"season": 0,
"sourceId": "string",
"tmdbId": 0,
"totalTimeMs": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

Notifications

In-app inbox: new episode of a followed series and read state

List the inbox notifications of a profile

Authorizations:

bearerAuth

query Parameters

profileId required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...
unread	boolean Quando true, devolve só as não lidas
limit	integer <int64> [ 1 .. 50 ] Default: 20

Responses

Response samples

Content type

application/json

{"items": [{"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"payload": {"episode": 0,
"fromEpisode": 0,
"fromSeason": 0,
"identityKey": "string",
"mediaId": "string",
"newCount": 0,
"poster": "string",
"season": 0,
"title": "string"
},
"readAt": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"unreadCount": 0
}

Mark an inbox notification as read

read=false clears the mark. profileId is required: it is what proves the notification belongs to a profile of the caller.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Request Body schema: application/json
required

read

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"read": true
}

Response samples

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

health

Liveness probe

Responses

Response samples

200
500
default

Content type

application/json

{"message": "string"
}

Readiness probe

Responses

Response samples

200
500
503

Content type

application/json

{"status": "string"
}

Startup probe

Responses

Response samples

200
500
503

Content type

application/json

{"status": "string"
}

Resellers

Generate a code that links this account to a reseller

The code only links a reseller to the account; it never signs anyone in. Valid for 24 hours, and generating a new one invalidates the previous.

Authorizations:

bearerAuth

Responses

Response samples

201
401
404
500

Content type

application/json

{"code": "string",
"expiresAt": "2019-08-24T14:15:22Z"
}

Sports

List the football matches of the day, marking the profile's followed teams

Authorizations:

bearerAuth

query Parameters

date	string^\d{4}-\d{2}-\d{2}$ Dia da agenda em America/Sao_Paulo. Vazio: hoje.
profileId required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/json

{"date": "string",
"matches": [{"away": {"logo": "string",
"name": "string",
"slug": "string"
},
"broadcasters": ["string"
],
"channels": [{"name": "string",
"provider_id": "string",
"source": "title",
"stream_id": 0
}
],
"elapsed": 0,
"followed": true,
"home": {"logo": "string",
"name": "string",
"slug": "string"
},
"id": "string",
"kickoff": "2019-08-24T14:15:22Z",
"league": {"name": "string",
"slug": "string"
},
"score": {"away": 0,
"home": 0
},
"state": "pre",
"status": "string"
}
]
}

List the football teams available to follow, marking the profile's followed ones

Authorizations:

bearerAuth

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/json

{"teams": [{"followed": true,
"leagues": [{"name": "string",
"slug": "string"
}
],
"logo": "string",
"name": "string",
"slug": "string"
}
]
}

List the football teams followed by a profile

Authorizations:

bearerAuth

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

Content type

application/json

{"teams": [{"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"logo": "string",
"name": "string",
"slug": "string"
}
]
}

Follow a football team

Authorizations:

bearerAuth

Request Body schema: application/json
required

logo	string <= 500 characters
name required	string [ 1 .. 120 ] characters
profileId required	string <uuid>
slug required	string [ 1 .. 120 ] characters ^[a-z0-9-]+$ Identidade do time, do campo slug da agenda

Responses

Request samples

Payload

Content type

application/json

{"logo": "string",
"name": "string",
"profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
"slug": "string"
}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"logo": "string",
"name": "string",
"slug": "string"
}

Unfollow a football team

Authorizations:

bearerAuth

path Parameters

slug

required

string [ 1 .. 120 ] characters ^[a-z0-9-]+$

query Parameters

profileId

required

string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Responses

Response samples

400
401
404
422
500

Content type

application/problem+json

{"detail": "Property foo is required but is missing.",
"errors": [{"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}

mamut-api (1.0.0)

Authentication

Sign in to the dashboard with a Turnstile token

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign up with a Turnstile token

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Generate a single-use sign-in code

Authorizations:

Responses

Response samples

Get the authenticated user

Authorizations:

Responses

Response samples

Refresh the access token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a device login session

Request Body schema: application/json

Responses

Request samples

Response samples

Check the status of a device session code

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Approve a pending device session

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign in with email and password

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign in with a Google account

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign in with a single-use code

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Email verification

Confirm a pending email change

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request a new email verification link

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Cancel a pending email change or revert a confirmed one

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify the account email

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required