Sign in

This API gets the details of the provided {lockReference} in Gameball.

get/api/v4.0/integrations/locks/{lockReference}

Path parameters

lockReferencestring required

The lock reference identifier to get its details.

Response

Lock details retrieved successfully

customerIdstring

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

isUsedboolean

Indicates whether the provided lock is marked as used or not by the customer.

usedAtstring date-time

The date and time when the provided lock was marked as used.

isExpiredboolean

Indicates whether the provided lock is marked as expired or not.

expiredAtstring date-time

The date and time when the provided lock was marked as expired.

Changes