/secret/{secret

The name of the secret claim. This is the claim_name entered when creating a Website or Secret Word claim.

200

Success

Response body

object

number

The numeric ID of the secret.

event_id

number

The numeric ID of the event.

event

object

number

The numeric ID of the event.

fancy_id

string

length ≤ 256

A string that uniquely identifies the event. This is generated based on the event name at event creation and cannot be edited.

name

string

length ≤ 256

The name of the event.

description

string

length ≤ 1500

The description of the event. Max length is 1500 characters.

city

string

length ≤ 256

The city where event takes place. This field is optional for virtual events.

country

string

length ≤ 256

The country where the event takes place. This field is optional for virtual events.

event_url

string

The URL of a website the attendees should visit.

image_url

string

This provides the URL of the POAP image.
To request a smaller, lower resolution version of the image, simply append "?size=small" to the end of the URL. For example, "https://poap.xyz/image.png?size=small".

animation_url

string

The URL of the POAP animation.

year

number

The year the event took place.

start_date

date

The start date of the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

end_date

date

The end date of the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

expiry_date

date

The limit date for POAPs to be claimable for the event. Must be in YYYY-MM-DD or MM-DD-YYYY format.

from_admin

boolean

Whether the event was created by a POAP admin.

virtual_event

boolean

Defaults to false

Whether the event is virtual.

event_template_id

number

Defaults to 1

The ID of the event template for POAP’s claim page (https://app.poap.xyz/claim/xxxxxx).

private_event

boolean

Defaults to false

If true, the event is private and will be filtered out in POAP’s frontend. Test events should be made private.

claim_name

string

The name of the secret claim. This is the claim_name entered when creating a Website or Secret Word claim.

from

date-time

The date from which the secret is valid. Must be ISO format YYYY-MM-DDTHH-MM-SSZ.

date-time

The date to which the secret is valid. Must be ISO format YYYY-MM-DDTHH-MM-SSZ.

timezone

number

-12 to 12

Defaults to 0

The timezone UTC offset for the secret date.

active

boolean

Defaults to true

Whether the secret is active.

total

number

The total number of claims available for the secret claim.

claimed

number

The number of claims already claimed for the secret claim.

created_date

date-time

The date when the secret was created.

is_collectors_game_enabled

boolean

Whether the owner has opted to include an anti farming game or not for this distribution method.

type

string

word website

200Success