API docs by Redocly

STQRY Public API (1.1.0)

Download OpenAPI specification:

API Support: support@stqry.com URL: https://support.stqry.com License: Copyright OnCell Systems, Inc.

API documentation for STQRY's public API

Account

Get the account associated with the API token

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "settings": {
    }
}

Accounts

Returns the accounts the API token can act on behalf of

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "accounts": [
    ]
}

AppListingItems

Returns full detail for one tour item, including its sub-items

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

id
required
integer

ID of the app listing item

Responses

Response samples

Content type
application/json
{
  • "app_listing_item": {
    }
}

AppListings

Returns a project's store/app listing with a minimal list of its items

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

Responses

Response samples

Content type
application/json
{
  • "app_listing": {
    }
}

BadgeGroups

Returns a list of badge groups for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "badge_groups": [
    ]
}

Creates a new badge group

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

BadgeGroup

name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
track_progress
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "track_progress": true,
  • "badge_group_media_item_id": 0,
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "badge_group": {
    }
}

Returns a single badge group

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the BadgeGroup to retrieve

Responses

Response samples

Content type
application/json
{
  • "badge_group": {
    }
}

Updates an existing badge group

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the BadgeGroup to update

Request Body schema: application/json
required

BadgeGroup

name
string
primary_language
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
track_progress
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "track_progress": true,
  • "badge_group_media_item_id": 0,
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "badge_group": {
    }
}

Updates an existing badge group

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the BadgeGroup to update

Request Body schema: application/json
required

BadgeGroup

name
string
primary_language
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
track_progress
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "track_progress": true,
  • "badge_group_media_item_id": 0,
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "badge_group": {
    }
}

Deletes an existing badge group

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the BadgeGroup to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole badge group)

Responses

Response samples

Content type
application/json
{
  • "badge_group": {
    }
}

Get appears_in graph for a BadgeGroup

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the BadgeGroup

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Badges

Returns a list of badges for a badge group

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Search query (matches name)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "badges": [
    ]
}

Creates a new badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

Request Body schema: application/json
required

Badge

name
string
position
integer
boolean or null
integer or null
string or null
integer or null
string or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "visible_on_badge_list": true,
  • "badge_media_item_id": 0,
  • "unearned_link_type": "Collection",
  • "unearned_link_id": 0,
  • "earned_link_type": "Collection",
  • "earned_link_id": 0,
  • "title": {
    },
  • "short_title": {
    },
  • "subtitle": {
    },
  • "unearned_link_label": {
    },
  • "unearned_title": {
    },
  • "unearned_body": {
    },
  • "earned_link_label": {
    },
  • "earned_title": {
    },
  • "earned_body": {
    }
}

Response samples

Content type
application/json
{
  • "badge": {
    }
}

Updates the positions of badges within a badge group

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of badge position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

id
required
integer

ID of the Badge to retrieve

Responses

Response samples

Content type
application/json
{
  • "badge": {
    }
}

Updates an existing badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

id
required
integer

ID of the Badge to update

Request Body schema: application/json
required

Badge

name
string
position
integer
boolean or null
integer or null
string or null
integer or null
string or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "visible_on_badge_list": true,
  • "badge_media_item_id": 0,
  • "unearned_link_type": "Collection",
  • "unearned_link_id": 0,
  • "earned_link_type": "Collection",
  • "earned_link_id": 0,
  • "title": {
    },
  • "short_title": {
    },
  • "subtitle": {
    },
  • "unearned_link_label": {
    },
  • "unearned_title": {
    },
  • "unearned_body": {
    },
  • "earned_link_label": {
    },
  • "earned_title": {
    },
  • "earned_body": {
    }
}

Response samples

Content type
application/json
{
  • "badge": {
    }
}

Updates an existing badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

id
required
integer

ID of the Badge to update

Request Body schema: application/json
required

Badge

name
string
position
integer
boolean or null
integer or null
string or null
integer or null
string or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "visible_on_badge_list": true,
  • "badge_media_item_id": 0,
  • "unearned_link_type": "Collection",
  • "unearned_link_id": 0,
  • "earned_link_type": "Collection",
  • "earned_link_id": 0,
  • "title": {
    },
  • "short_title": {
    },
  • "subtitle": {
    },
  • "unearned_link_label": {
    },
  • "unearned_title": {
    },
  • "unearned_body": {
    },
  • "earned_link_label": {
    },
  • "earned_title": {
    },
  • "earned_body": {
    }
}

Response samples

Content type
application/json
{
  • "badge": {
    }
}

Deletes an existing badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

id
required
integer

ID of the Badge to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole badge)

Responses

Response samples

Content type
application/json
{
  • "badge": {
    }
}

Get appears_in graph for a Badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

id
required
integer

ID of the Badge

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Codes

Returns a list of codes for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "coupon_code" "access_code" "valid_from" "valid_to" "redemptions" "id"

Field to sort by (coupon_code is deprecated; use access_code)

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

include_archived
boolean

Include archived codes

tags
string

Comma separated list of tags. Tags are ANDed

valid_now
boolean

Currently valid codes

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "codes": [
    ]
}

Creates a new code

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Returns a single code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": {
    }
}

Updates an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Updates an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to retrieve

Request Body schema: application/json
required

Code

required
object (CodePartial)

Writable code fields

Responses

Request samples

Content type
application/json
{
  • "code": {
    }
}

Response samples

Content type
application/json
{
  • "code": {
    }
}

Deletes an existing code

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Code to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

CollectionItems

Returns a list of collection items for a collection

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "collection_items": [
    ]
}

Creates a new collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates the positions of collection items within a collection

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of collection item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to update

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Updates an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to update

Request Body schema: application/json
required

CollectionItem

position
integer
item_type
string
Enum: "Collection" "Screen" "CollectionItem"

Type of the linked item

item_id
integer
integer or null
number or null
number or null
string or null
string or null
string or null
integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "item_type": "Collection",
  • "item_id": 0,
  • "item_number": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_pin_icon": "string",
  • "map_pin_style": "string",
  • "map_pin_colour": "string",
  • "map_layer_id": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "collection_item": {
    }
}

Deletes an existing collection item

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get appears_in graph for a CollectionItem

Authorizations:
ApiKeyAuth
path Parameters
collection_id
required
integer

ID of the parent Collection

id
required
integer

ID of the CollectionItem

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Collections

Returns a list of collections for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

tags
string

Comma separated list of tags. Tags are ANDed

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "collections": [
    ]
}

Creates a new collection

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
boolean
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "description": {
    },
  • "file_size": {
    },
  • "stqry_directory_description": {
    },
  • "stqry_directory_about": {
    },
  • "stqry_directory_tips": {
    },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Returns a single collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to retrieve

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Updates an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to update

Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
boolean
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "description": {
    },
  • "file_size": {
    },
  • "stqry_directory_description": {
    },
  • "stqry_directory_about": {
    },
  • "stqry_directory_tips": {
    },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Updates an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to update

Request Body schema: application/json
required

Collection

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
required
string
Enum: "image_and_title" "image" "none" "short" "tall"
list_layout
required
string
Enum: "wide" "grid" "list"
tour_mode
required
string
Enum: "self_guided" "guided" "auto_play"
initial_layout
required
string
Enum: "default" "map"
map_view_enabled
required
boolean
search_enabled
required
boolean
keypad_enabled
required
boolean
qr_enabled
required
boolean
sort_by
required
string
Enum: "list_order" "alphabetical" "distance"
code_lock
boolean
integer or null
integer or null
integer or null
integer or null
type
string
Value: "list"
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "description": {
    },
  • "file_size": {
    },
  • "stqry_directory_description": {
    },
  • "stqry_directory_about": {
    },
  • "stqry_directory_tips": {
    },
  • "header_layout": "image_and_title",
  • "list_layout": "wide",
  • "tour_mode": "self_guided",
  • "initial_layout": "default",
  • "map_view_enabled": true,
  • "search_enabled": true,
  • "keypad_enabled": true,
  • "qr_enabled": true,
  • "sort_by": "list_order",
  • "code_lock": true,
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "search",
  • "parent_collection_id": 0,
  • "search_types": 0,
  • "default_search_types": 0
}

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Deletes an existing collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole collection)

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Get appears_in graph for a Collection

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Duplicates a collection. Clones the collection, its items, triggers, map_routes and map_items; referenced Screens and MediaItems are shared with the source.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Collection to duplicate

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

CustomFields

Returns the account's custom field definitions

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "position" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "custom_fields": [
    ]
}

Returns a single custom field definition

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the custom field

Responses

Response samples

Content type
application/json
{
  • "custom_field": {
    }
}

FormSubmissions

Returns a list of form submissions

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Search query over submission data

sort_field
string
Enum: "id" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "form_submissions": [
    ]
}

Creates a form submission

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

FormSubmission

form_id
required
integer

ID of the form to submit

required
object

Submission data keyed by form field slug

Responses

Request samples

Content type
application/json
{
  • "form_id": 0,
  • "data": { }
}

Response samples

Content type
application/json
{
  • "form_submission": {
    }
}

Returns a single form submission

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the form submission

Responses

Response samples

Content type
application/json
{
  • "form_submission": {
    }
}

Forms

Returns the account's forms

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Name search query

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "forms": [
    ]
}

Returns a single form with its fields

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the form

Responses

Response samples

Content type
application/json
{
  • "form": {
    }
}

LinkedItems

Returns a project's linked items

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "linked_items": [
    ]
}

Creates a new linked item

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

Request Body schema: application/json
required

Linked item

item_type
string
Enum: "Screen" "Collection" "MediaItem"

Type of the linked item

item_id
integer

Id of the linked Screen / Collection / MediaItem (scoped to the calling account)

integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "item_type": "Screen",
  • "item_id": 0,
  • "item_number": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "linked_item": {
    }
}

Returns a single linked item

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

id
required
integer

ID of the linked item

Responses

Response samples

Content type
application/json
{
  • "linked_item": {
    }
}

Updates a linked item

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

id
required
integer

ID of the linked item

Request Body schema: application/json
required

Linked item

item_type
string
Enum: "Screen" "Collection" "MediaItem"

Type of the linked item

item_id
integer

Id of the linked Screen / Collection / MediaItem (scoped to the calling account)

integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "item_type": "Screen",
  • "item_id": 0,
  • "item_number": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "linked_item": {
    }
}

Updates a linked item

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

id
required
integer

ID of the linked item

Request Body schema: application/json
required

Linked item

item_type
string
Enum: "Screen" "Collection" "MediaItem"

Type of the linked item

item_id
integer

Id of the linked Screen / Collection / MediaItem (scoped to the calling account)

integer or null
geofence
string
Enum: "off" "gps" "beacon"

Geofence mode

GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "item_type": "Screen",
  • "item_id": 0,
  • "item_number": 0,
  • "geofence": "off",
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "linked_item": {
    }
}

Deletes a linked item

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the parent project

id
required
integer

ID of the linked item

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapFeatures

Returns features for a MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Name search query

sort_field
string

Sort field; one of id, name, created_at, updated_at

sort_direction
string
Enum: "ASC" "DESC"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_features": [
    ]
}

Creates a new MapFeature

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

Request Body schema: application/json
required
name
required
string
required
object or string
string or null
integer or null
object (MapFeatureSettings)

Map feature settings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geojson": { },
  • "label": "string",
  • "map_poi_id": 0,
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "map_feature": {
    }
}

Returns a single MapFeature

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

id
required
integer

ID of the MapFeature

Responses

Response samples

Content type
application/json
{
  • "map_feature": {
    }
}

Updates a MapFeature

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

id
required
integer

ID of the MapFeature

Request Body schema: application/json
required
name
string
object or string
string or null
integer or null
object (MapFeatureSettings)

Map feature settings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geojson": { },
  • "label": "string",
  • "map_poi_id": 0,
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "map_feature": {
    }
}

Updates a MapFeature

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

id
required
integer

ID of the MapFeature

Request Body schema: application/json
required
name
string
object or string
string or null
integer or null
object (MapFeatureSettings)

Map feature settings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "geojson": { },
  • "label": "string",
  • "map_poi_id": 0,
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "map_feature": {
    }
}

Deletes a MapFeature

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

layer_id
required
integer

ID of the MapLayer

id
required
integer

ID of the MapFeature

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapItems

Returns a list of map items

Authorizations:
ApiKeyAuth
query Parameters
collection_id
integer

Filter to map items belonging to this Collection. Provide at most one of collection_id or story_section_id; sending both returns 422.

story_section_id
integer

Filter to map items belonging to this StorySection. Provide at most one of collection_id or story_section_id; sending both returns 422.

page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_items": [
    ]
}

Creates a new map item linked to a Collection or StorySection

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
lat
required
number <float>

Latitude (-90..90)

lng
required
number <float>

Longitude (-180..180)

link_type
required
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "info_window" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"

Link kind. When 'url', url is required. When item_type is blank, link_text is required.

integer or null
integer or null
string or null
string or null
string or null
integer or null
string or null
string or null
string or null
string or null
string or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "link_type": "twitter",
  • "collection_id": 0,
  • "story_section_id": 0,
  • "link_text": "string",
  • "url": "string",
  • "info_window": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "stock_icon": "string",
  • "stock_icon_icon": "string",
  • "stock_icon_style": "string",
  • "stock_icon_colour": "string",
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_item": {
    }
}

Returns a single map item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "map_item": {
    }
}

Updates an existing map item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapItem to update

Request Body schema: application/json
required
lat
number <float>

Latitude (-90..90)

lng
number <float>

Longitude (-180..180)

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "info_window" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
string or null
string or null
string or null
integer or null
string or null
string or null
string or null
string or null
string or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "link_type": "twitter",
  • "link_text": "string",
  • "url": "string",
  • "info_window": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "stock_icon": "string",
  • "stock_icon_icon": "string",
  • "stock_icon_style": "string",
  • "stock_icon_colour": "string",
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_item": {
    }
}

Updates an existing map item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapItem to update

Request Body schema: application/json
required
lat
number <float>

Latitude (-90..90)

lng
number <float>

Longitude (-180..180)

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "info_window" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
string or null
string or null
string or null
integer or null
string or null
string or null
string or null
string or null
string or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "lat": 0.1,
  • "lng": 0.1,
  • "link_type": "twitter",
  • "link_text": "string",
  • "url": "string",
  • "info_window": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "stock_icon": "string",
  • "stock_icon_icon": "string",
  • "stock_icon_style": "string",
  • "stock_icon_colour": "string",
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_item": {
    }
}

Deletes a map item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapLayers

Returns layers for a Map

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Name search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_layers": [
    ]
}

Creates a new MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

Request Body schema: application/json
required
name
required
string
subtype_type
required
string
Enum: "MapLayerMapbox" "MapLayerStatic" "MapLayerGeoreferenced"
subtype
object

Subtype payload; shape depends on subtype_type. Mapbox: style_id, style_url, access_token. Static / Georeferenced: tile_format, map_media_item_id (optional, must be a MediaItemMap or a mappable MediaItemImage).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subtype_type": "MapLayerMapbox",
  • "subtype": { }
}

Response samples

Content type
application/json
{
  • "map_layer": {
    }
}

Reorder MapLayers within a Map

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

Request Body schema: application/json
required
required
Array of objects

Layers to reposition; all ids must belong to this map

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapLayer

Responses

Response samples

Content type
application/json
{
  • "map_layer": {
    }
}

Updates a MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapLayer

Request Body schema: application/json
required
name
string
subtype
object

Subtype updates. Mapbox: style_id, style_url, access_token. Static / Georeferenced: tile_format, map_media_item_id. subtype_type is immutable.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subtype": { }
}

Response samples

Content type
application/json
{
  • "map_layer": {
    }
}

Updates a MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapLayer

Request Body schema: application/json
required
name
string
subtype
object

Subtype updates. Mapbox: style_id, style_url, access_token. Static / Georeferenced: tile_format, map_media_item_id. subtype_type is immutable.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subtype": { }
}

Response samples

Content type
application/json
{
  • "map_layer": {
    }
}

Deletes a MapLayer

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapLayer

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapPathNodes

Returns path nodes for a Map

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

query Parameters
layer_id
integer

Optional MapLayer id; restricts results to nodes on this layer

page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string

Sort field; one of id, created_at, updated_at

sort_direction
string
Enum: "ASC" "DESC"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_path_nodes": [
    ]
}

Creates a new MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

Request Body schema: application/json
required
map_layer_id
required
integer

Id of an existing MapLayer on this Map

lat
required
number <float>

Latitude (-90..90)

lng
required
number <float>

Longitude (-180..180)

map_feature_ids
Array of integers

Optional MapFeature ids; each must reference a feature on this Map

Responses

Request samples

Content type
application/json
{
  • "map_layer_id": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_feature_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "map_path_node": {
    }
}

Returns a single MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPathNode

Responses

Response samples

Content type
application/json
{
  • "map_path_node": {
    }
}

Updates a MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPathNode

Request Body schema: application/json
required
map_layer_id
integer

Id of an existing MapLayer on this Map

lat
number <float>

Latitude (-90..90)

lng
number <float>

Longitude (-180..180)

map_feature_ids
Array of integers

MapFeature ids; each must reference a feature on this Map. Pass [] to clear.

Responses

Request samples

Content type
application/json
{
  • "map_layer_id": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_feature_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "map_path_node": {
    }
}

Updates a MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPathNode

Request Body schema: application/json
required
map_layer_id
integer

Id of an existing MapLayer on this Map

lat
number <float>

Latitude (-90..90)

lng
number <float>

Longitude (-180..180)

map_feature_ids
Array of integers

MapFeature ids; each must reference a feature on this Map. Pass [] to clear.

Responses

Request samples

Content type
application/json
{
  • "map_layer_id": 0,
  • "lat": 0.1,
  • "lng": 0.1,
  • "map_feature_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "map_path_node": {
    }
}

Deletes a MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPathNode

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapPaths

Returns paths for a Map

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

query Parameters
layer_id
integer

Optional MapLayer id; restricts results to paths whose nodes both belong to this layer

page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string

Sort field; one of id, created_at, updated_at, cost

sort_direction
string
Enum: "ASC" "DESC"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_paths": [
    ]
}

Creates a new MapPath

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

Request Body schema: application/json
required
start_node_id
required
integer

Id of an existing MapPathNode on this Map

end_node_id
required
integer

Id of an existing MapPathNode on this Map; must differ from start_node_id

Array of numbers or Array of numbers or null
integer or null
boolean or null
boolean or null
string or null

Responses

Request samples

Content type
application/json
{
  • "start_node_id": 0,
  • "end_node_id": 0,
  • "linestring": [
    ],
  • "cost": 0,
  • "cost_override": true,
  • "accessible": true,
  • "direction": "bidirectional"
}

Response samples

Content type
application/json
{
  • "map_path": {
    }
}

Returns a single MapPath

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPath

Responses

Response samples

Content type
application/json
{
  • "map_path": {
    }
}

Updates a MapPath

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPath

Request Body schema: application/json
required
start_node_id
integer

Id of an existing MapPathNode on this Map

end_node_id
integer

Id of an existing MapPathNode on this Map

Array of numbers or Array of numbers or null
integer or null
boolean or null
boolean or null
string or null

Responses

Request samples

Content type
application/json
{
  • "start_node_id": 0,
  • "end_node_id": 0,
  • "linestring": [
    ],
  • "cost": 0,
  • "cost_override": true,
  • "accessible": true,
  • "direction": "bidirectional"
}

Response samples

Content type
application/json
{
  • "map_path": {
    }
}

Updates a MapPath

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPath

Request Body schema: application/json
required
start_node_id
integer

Id of an existing MapPathNode on this Map

end_node_id
integer

Id of an existing MapPathNode on this Map

Array of numbers or Array of numbers or null
integer or null
boolean or null
boolean or null
string or null

Responses

Request samples

Content type
application/json
{
  • "start_node_id": 0,
  • "end_node_id": 0,
  • "linestring": [
    ],
  • "cost": 0,
  • "cost_override": true,
  • "accessible": true,
  • "direction": "bidirectional"
}

Response samples

Content type
application/json
{
  • "map_path": {
    }
}

Deletes a MapPath

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPath

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Splits a MapPath at an intermediate MapPathNode

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPath to split

Request Body schema: application/json
required
node_id
required
integer

Id of an existing MapPathNode on this Map to split the path at

Responses

Request samples

Content type
application/json
{
  • "node_id": 0
}

Response samples

Content type
application/json
{
  • "map_paths": [
    ]
}

MapPois

Returns POIs for a Map

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Name search query

sort_field
string

Sort field; one of id, name, created_at, updated_at

sort_direction
string
Enum: "ASC" "DESC"

Sort direction

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_pois": [
    ]
}

Creates a new MapPOI

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

Request Body schema: application/json
required
name
required
string
string or null
string or null
integer or null
string or null
integer or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "header_media_item_id": 0,
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_poi": {
    }
}

Returns a single MapPOI

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPOI

Responses

Response samples

Content type
application/json
{
  • "map_poi": {
    }
}

Updates a MapPOI

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPOI

Request Body schema: application/json
required
name
string
string or null
string or null
integer or null
string or null
integer or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "header_media_item_id": 0,
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_poi": {
    }
}

Updates a MapPOI

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPOI

Request Body schema: application/json
required
name
string
string or null
string or null
integer or null
string or null
integer or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "item_id": 0,
  • "item_type": "Collection",
  • "header_media_item_id": 0,
  • "icon_media_item_id": 0
}

Response samples

Content type
application/json
{
  • "map_poi": {
    }
}

Deletes a MapPOI

Authorizations:
ApiKeyAuth
path Parameters
map_id
required
integer

ID of the Map

id
required
integer

ID of the MapPOI

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

MapRoutes

Returns a list of map routes

Authorizations:
ApiKeyAuth
query Parameters
collection_id
integer

Filter to map routes belonging to this Collection. Provide at most one of collection_id or story_section_id; sending both returns 422.

story_section_id
integer

Filter to map routes belonging to this StorySection. Provide at most one of collection_id or story_section_id; sending both returns 422.

page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "map_routes": [
    ]
}

Creates a new map route from GeoJSON or GPX

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
geojson
required
string

GeoJSON FeatureCollection string or GPX XML string. Required.

integer or null
integer or null
integer or null
integer or null

Responses

Request samples

Content type
application/json
{
  • "geojson": "string",
  • "collection_id": 0,
  • "story_section_id": 0,
  • "map_id": 0,
  • "layer_id": 0
}

Response samples

Content type
application/json
{
  • "map_route": {
    }
}

Returns a single map route

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapRoute to retrieve

Responses

Response samples

Content type
application/json
{
  • "map_route": {
    }
}

Updates an existing map route

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapRoute to update

Request Body schema: application/json
required
geojson
required
string

GeoJSON FeatureCollection string or GPX XML string. Required and the only mutable field.

Responses

Request samples

Content type
application/json
{
  • "geojson": "string"
}

Response samples

Content type
application/json
{
  • "map_route": {
    }
}

Updates an existing map route

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapRoute to update

Request Body schema: application/json
required
geojson
required
string

GeoJSON FeatureCollection string or GPX XML string. Required and the only mutable field.

Responses

Request samples

Content type
application/json
{
  • "geojson": "string"
}

Response samples

Content type
application/json
{
  • "map_route": {
    }
}

Deletes a map route

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapRoute to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Adds elevation values to a map route's geojson coordinates

Calls an external elevation service (Stadia Maps) and mutates the stored geojson by attaching elevation (z) values to each coordinate. May fail with 502 if the upstream is unavailable. Side effect: the route's geojson is permanently modified.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MapRoute to enrich with elevation

Responses

Response samples

Content type
application/json
{
  • "map_route": {
    }
}

Maps

Returns a list of maps for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Name search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "maps": [
    ]
}

Creates a new map

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "map": {
    }
}

Returns a single map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map to retrieve

Responses

Response samples

Content type
application/json
{
  • "map": {
    }
}

Updates an existing map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map to update

Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "map": {
    }
}

Updates an existing map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map to update

Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "map": {
    }
}

Deletes a map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get appears_in graph for a Map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Find the shortest path between two MapPathNodes on this map

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Map

query Parameters
start_node_id
required
integer

ID of the starting MapPathNode; must belong to this map

end_node_id
required
integer

ID of the ending MapPathNode; must belong to this map

accessible_only
boolean

When true, restrict to accessible paths only

Responses

Response samples

Content type
application/json
{
  • "node_ids": [
    ],
  • "total_cost": 0,
  • "nodes": [
    ]
}

MarketingLists

Returns a list of marketing lists

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Name search query

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "marketing_lists": [
    ]
}

Creates a marketing list

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

MarketingList

name
required
string

Name of the marketing list

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

Returns a single marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Responses

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

Updates a marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Request Body schema: application/json
required

MarketingList

string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

Updates a marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Request Body schema: application/json
required

MarketingList

string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

Deletes a marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Subscribes a person to the marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Request Body schema: application/json
required

Person to subscribe

person_id
integer

Responses

Request samples

Content type
application/json
{
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

Unsubscribes a person from the marketing list

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the marketing list

Request Body schema: application/json
required

Person to unsubscribe

person_id
integer

Responses

Request samples

Content type
application/json
{
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "marketing_list": {
    }
}

MediaItems

Returns a list of media_items for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "media_items": [
    ]
}

Creates a new media item

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
compress_media
boolean

Whether to compress media

allow_cropping_media
boolean

Whether to prefer uncropped media

primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

mappable
boolean

Whether the image is used as a map

georeferenced
boolean

Whether the mappable image is georeferenced

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "compress_media": true,
  • "allow_cropping_media": true,
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Returns a single media_item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Updates an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to update

Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
compress_media
boolean

Whether to compress media

allow_cropping_media
boolean

Whether to prefer uncropped media

primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

mappable
boolean

Whether the image is used as a map

georeferenced
boolean

Whether the mappable image is georeferenced

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "compress_media": true,
  • "allow_cropping_media": true,
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Updates an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to update

Request Body schema: application/json
required

MediaItem

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
compress_media
boolean

Whether to compress media

allow_cropping_media
boolean

Whether to prefer uncropped media

primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
integer or object (TranslatedUploadedFileId)
type
string
Value: "image"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

mappable
boolean

Whether the image is used as a map

georeferenced
boolean

Whether the mappable image is georeferenced

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "compress_media": true,
  • "allow_cropping_media": true,
  • "primary_language": "alq",
  • "file_uploaded_file_id": 0,
  • "type": "data"
}

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Deletes an existing media item

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole media item)

Responses

Response samples

Content type
application/json
{
  • "media_item": {
    }
}

Get appears_in graph for a MediaItem

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the MediaItem

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

People

Returns a list of people for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "given_name" "family_name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query (name or email)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "people": [
    ]
}

Creates a new person

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Person

string or null
string or null
string or null
string or null
string or null
string or null
Array of objects or null
Array of objects or null
Array of objects or null
Array of objects or null

Responses

Request samples

Content type
application/json
{
  • "given_name": "string",
  • "family_name": "string",
  • "date_of_birth": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "notes": "string",
  • "email_addresses": [
    ],
  • "phone_numbers": [
    ],
  • "addresses": [
    ],
  • "field_values": [
    ]
}

Response samples

Content type
application/json
{
  • "person": {
    }
}

Returns a single person

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the person

Responses

Response samples

Content type
application/json
{
  • "person": {
    }
}

Updates an existing person

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the person

Request Body schema: application/json
required

Person

string or null
string or null
string or null
string or null
string or null
string or null
Array of objects or null
Array of objects or null
Array of objects or null
Array of objects or null

Responses

Request samples

Content type
application/json
{
  • "given_name": "string",
  • "family_name": "string",
  • "date_of_birth": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "notes": "string",
  • "email_addresses": [
    ],
  • "phone_numbers": [
    ],
  • "addresses": [
    ],
  • "field_values": [
    ]
}

Response samples

Content type
application/json
{
  • "person": {
    }
}

Updates an existing person

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the person

Request Body schema: application/json
required

Person

string or null
string or null
string or null
string or null
string or null
string or null
Array of objects or null
Array of objects or null
Array of objects or null
Array of objects or null

Responses

Request samples

Content type
application/json
{
  • "given_name": "string",
  • "family_name": "string",
  • "date_of_birth": "string",
  • "gender": "male",
  • "pronouns": "string",
  • "notes": "string",
  • "email_addresses": [
    ],
  • "phone_numbers": [
    ],
  • "addresses": [
    ],
  • "field_values": [
    ]
}

Response samples

Content type
application/json
{
  • "person": {
    }
}

Deletes a person

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the person

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Products

Returns a list of products for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "products": [
    ]
}

Returns a single product

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Product to retrieve

Responses

Response samples

Content type
application/json
{
  • "product": {
    }
}

ProjectTabs

Returns the project's tabs

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tabs": [
    ]
}

Link an item as a new tab on a project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

Request Body schema: application/json
required
Array of strings or any
Array of integers or any
Array of strings or any
Array of booleans or any

Responses

Request samples

Content type
application/json
{
  • "item_type": [
    ],
  • "item_id": [
    ],
  • "icon": [
    ],
  • "custom_icon": [
    ]
}

Response samples

Content type
application/json
{
  • "tab": {
    }
}

Reorder the project's tabs in bulk

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

Request Body schema: application/json
required
required
Array of Array of objects or any

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single tab

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

id
required
integer

ID of the tab

Responses

Response samples

Content type
application/json
{
  • "tab": {
    }
}

Update a tab's icon or position

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

id
required
integer

ID of the tab

Request Body schema: application/json
required
Array of strings or any
Array of booleans or any
Array of integers or any

Responses

Request samples

Content type
application/json
{
  • "icon": [
    ],
  • "custom_icon": [
    ],
  • "position": [
    ]
}

Response samples

Content type
application/json
{
  • "tab": {
    }
}

Update a tab's icon or position

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

id
required
integer

ID of the tab

Request Body schema: application/json
required
Array of strings or any
Array of booleans or any
Array of integers or any

Responses

Request samples

Content type
application/json
{
  • "icon": [
    ],
  • "custom_icon": [
    ],
  • "position": [
    ]
}

Response samples

Content type
application/json
{
  • "tab": {
    }
}

Remove a tab from a project

Authorizations:
ApiKeyAuth
path Parameters
project_id
required
integer

ID of the project

id
required
integer

ID of the tab

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Projects

Returns a list of projects for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

tags
string

Comma separated list of tags. Tags are ANDed

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "projects": [
    ]
}

Creates a new project

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Project

name
required
string
projectable_type
required
string
Enum: "Project::App" "Project::Kiosk" "Project::Signage"
primary_language_code
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
additional_language_codes
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

string or null
integer or null
badge_group_ids
Array of integers
show_in_app_catalogue
boolean
published_on_android
boolean
published_on_ios
boolean
published_on_web
boolean
tags
Array of strings (TagList)

Array of tags to help orgainse and search

object (ProjectSettings)

Common project settings

integer or null
integer or null
integer or null
integer or null
integer or null
object
integer or null
integer or null
object (KioskProjectSettings)

Kiosk-project keybinding/settings configuration

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (SignageProjectSettings)

Signage-project settings

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "projectable_type": "Project::App",
  • "primary_language_code": "alq",
  • "additional_language_codes": [
    ],
  • "app_name": {
    },
  • "subdomain": "string",
  • "theme_id": 0,
  • "badge_group_ids": [
    ],
  • "show_in_app_catalogue": true,
  • "published_on_android": true,
  • "published_on_ios": true,
  • "published_on_web": true,
  • "tags": [
    ],
  • "settings": {
    },
  • "background_image_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "qr_code_logo_media_item_id": 0,
  • "icon_media_item_id": 0,
  • "loading_media_item_id": 0,
  • "colors": {
    },
  • "screensaver_media_item_id": 0,
  • "initial_screen_id": 0,
  • "kiosk_settings": {
    },
  • "title": {
    },
  • "start_text": {
    },
  • "signage_settings": {
    },
  • "language_keybindings": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Returns a single project

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project to retrieve

Responses

Response samples

Content type
application/json
{
  • "project": {
    }
}

Updates a project

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project to update

Request Body schema: application/json
required

Project

name
string
primary_language_code
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
additional_language_codes
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

string or null
integer or null
badge_group_ids
Array of integers
show_in_app_catalogue
boolean
published_on_android
boolean
published_on_ios
boolean
published_on_web
boolean
tags
Array of strings (TagList)

Array of tags to help orgainse and search

object (ProjectSettings)

Common project settings

integer or null
integer or null
integer or null
integer or null
integer or null
object
integer or null
integer or null
object (KioskProjectSettings)

Kiosk-project keybinding/settings configuration

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (SignageProjectSettings)

Signage-project settings

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language_code": "alq",
  • "additional_language_codes": [
    ],
  • "app_name": {
    },
  • "subdomain": "string",
  • "theme_id": 0,
  • "badge_group_ids": [
    ],
  • "show_in_app_catalogue": true,
  • "published_on_android": true,
  • "published_on_ios": true,
  • "published_on_web": true,
  • "tags": [
    ],
  • "settings": {
    },
  • "background_image_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "qr_code_logo_media_item_id": 0,
  • "icon_media_item_id": 0,
  • "loading_media_item_id": 0,
  • "colors": {
    },
  • "screensaver_media_item_id": 0,
  • "initial_screen_id": 0,
  • "kiosk_settings": {
    },
  • "title": {
    },
  • "start_text": {
    },
  • "signage_settings": {
    },
  • "language_keybindings": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Updates a project

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project to update

Request Body schema: application/json
required

Project

name
string
primary_language_code
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
additional_language_codes
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

string or null
integer or null
badge_group_ids
Array of integers
show_in_app_catalogue
boolean
published_on_android
boolean
published_on_ios
boolean
published_on_web
boolean
tags
Array of strings (TagList)

Array of tags to help orgainse and search

object (ProjectSettings)

Common project settings

integer or null
integer or null
integer or null
integer or null
integer or null
object
integer or null
integer or null
object (KioskProjectSettings)

Kiosk-project keybinding/settings configuration

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (SignageProjectSettings)

Signage-project settings

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language_code": "alq",
  • "additional_language_codes": [
    ],
  • "app_name": {
    },
  • "subdomain": "string",
  • "theme_id": 0,
  • "badge_group_ids": [
    ],
  • "show_in_app_catalogue": true,
  • "published_on_android": true,
  • "published_on_ios": true,
  • "published_on_web": true,
  • "tags": [
    ],
  • "settings": {
    },
  • "background_image_media_item_id": 0,
  • "code_background_media_item_id": 0,
  • "qr_code_logo_media_item_id": 0,
  • "icon_media_item_id": 0,
  • "loading_media_item_id": 0,
  • "colors": {
    },
  • "screensaver_media_item_id": 0,
  • "initial_screen_id": 0,
  • "kiosk_settings": {
    },
  • "title": {
    },
  • "start_text": {
    },
  • "signage_settings": {
    },
  • "language_keybindings": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Deletes a project (or one of its language translations)

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project to delete

query Parameters
language
string

If supplied, removes only the translation for this language code (cannot be the project's primary_language_code)

Responses

Response samples

Content type
application/json
{
  • "project": {
    }
}

Returns a CSV of public URLs for the project

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Project

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

QuizQuestionAnswers

Returns a list of answers for a question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Search query (matches answer_text)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "answers": [
    ]
}

Creates a new answer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

Request Body schema: application/json
required

QuizQuestionAnswer

position
integer
correct
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "correct": true,
  • "answer_media_item_id": 0,
  • "answer_text": {
    }
}

Response samples

Content type
application/json
{
  • "answer": {
    }
}

Updates the positions of answers within a question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of answer position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single answer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

id
required
integer

ID of the QuizQuestionAnswer to retrieve

Responses

Response samples

Content type
application/json
{
  • "answer": {
    }
}

Updates an existing answer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

id
required
integer

ID of the QuizQuestionAnswer to update

Request Body schema: application/json
required

QuizQuestionAnswer

position
integer
correct
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "correct": true,
  • "answer_media_item_id": 0,
  • "answer_text": {
    }
}

Response samples

Content type
application/json
{
  • "answer": {
    }
}

Updates an existing answer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

id
required
integer

ID of the QuizQuestionAnswer to update

Request Body schema: application/json
required

QuizQuestionAnswer

position
integer
correct
boolean
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "correct": true,
  • "answer_media_item_id": 0,
  • "answer_text": {
    }
}

Response samples

Content type
application/json
{
  • "answer": {
    }
}

Deletes an existing answer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

id
required
integer

ID of the QuizQuestionAnswer to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole answer)

Responses

Response samples

Content type
application/json
{
  • "answer": {
    }
}

Get appears_in graph for a QuizQuestionAnswer

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

question_id
required
integer

ID of the parent QuizQuestion

id
required
integer

ID of the QuizQuestionAnswer

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

QuizQuestions

Returns a list of quiz questions for a quiz

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

q
string

Search query (matches name)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "questions": [
    ]
}

Creates a new quiz question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

Request Body schema: application/json
required

QuizQuestion

name
string
position
integer
question_type
string
Enum: "single_text_choice" "single_image_choice" "multi_text_choice" "multi_image_choice" "free_text"
max_attempts
integer
integer or null
integer or null
integer or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "question_type": "single_text_choice",
  • "max_attempts": 0,
  • "correct_image_media_item_id": 0,
  • "incorrect_image_media_item_id": 0,
  • "correct_audio_media_item_id": 0,
  • "incorrect_audio_media_item_id": 0,
  • "title": {
    },
  • "question": {
    },
  • "correct_text": {
    },
  • "incorrect_text": {
    }
}

Response samples

Content type
application/json
{
  • "question": {
    }
}

Updates the positions of questions within a quiz

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of question position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single quiz question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

id
required
integer

ID of the QuizQuestion to retrieve

Responses

Response samples

Content type
application/json
{
  • "question": {
    }
}

Updates an existing quiz question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

id
required
integer

ID of the QuizQuestion to update

Request Body schema: application/json
required

QuizQuestion

name
string
position
integer
question_type
string
Enum: "single_text_choice" "single_image_choice" "multi_text_choice" "multi_image_choice" "free_text"
max_attempts
integer
integer or null
integer or null
integer or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "question_type": "single_text_choice",
  • "max_attempts": 0,
  • "correct_image_media_item_id": 0,
  • "incorrect_image_media_item_id": 0,
  • "correct_audio_media_item_id": 0,
  • "incorrect_audio_media_item_id": 0,
  • "title": {
    },
  • "question": {
    },
  • "correct_text": {
    },
  • "incorrect_text": {
    }
}

Response samples

Content type
application/json
{
  • "question": {
    }
}

Updates an existing quiz question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

id
required
integer

ID of the QuizQuestion to update

Request Body schema: application/json
required

QuizQuestion

name
string
position
integer
question_type
string
Enum: "single_text_choice" "single_image_choice" "multi_text_choice" "multi_image_choice" "free_text"
max_attempts
integer
integer or null
integer or null
integer or null
integer or null
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "position": 0,
  • "question_type": "single_text_choice",
  • "max_attempts": 0,
  • "correct_image_media_item_id": 0,
  • "incorrect_image_media_item_id": 0,
  • "correct_audio_media_item_id": 0,
  • "incorrect_audio_media_item_id": 0,
  • "title": {
    },
  • "question": {
    },
  • "correct_text": {
    },
  • "incorrect_text": {
    }
}

Response samples

Content type
application/json
{
  • "question": {
    }
}

Deletes an existing quiz question

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

id
required
integer

ID of the QuizQuestion to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole question)

Responses

Response samples

Content type
application/json
{
  • "question": {
    }
}

Get appears_in graph for a QuizQuestion

Authorizations:
ApiKeyAuth
path Parameters
quiz_id
required
integer

ID of the parent Quiz

id
required
integer

ID of the QuizQuestion

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Quizzes

Returns a list of quizzes for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "quizzes": [
    ]
}

Creates a new quiz

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Quiz

name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "quiz": {
    }
}

Returns a single quiz

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Quiz to retrieve

Responses

Response samples

Content type
application/json
{
  • "quiz": {
    }
}

Updates an existing quiz

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Quiz to update

Request Body schema: application/json
required

Quiz

name
string
primary_language
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "quiz": {
    }
}

Updates an existing quiz

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Quiz to update

Request Body schema: application/json
required

Quiz

name
string
primary_language
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    }
}

Response samples

Content type
application/json
{
  • "quiz": {
    }
}

Deletes an existing quiz

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Quiz to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole quiz)

Responses

Response samples

Content type
application/json
{
  • "quiz": {
    }
}

Get appears_in graph for a Quiz

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Quiz

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

Screens

Returns a list of screens for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "screens": [
    ]
}

Creates a new screen

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "stqry_directory_short_description": {
    },
  • "stqry_directory_full_description": {
    },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": {
    },
  • "html": {
    },
  • "css": {
    }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Returns a single screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to retrieve

Responses

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Updates an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to update

Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "stqry_directory_short_description": {
    },
  • "stqry_directory_full_description": {
    },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": {
    },
  • "html": {
    },
  • "css": {
    }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Updates an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to update

Request Body schema: application/json
required

Screen

One of
id
required
integer
translated_languages
required
Array of strings (ContentLanguage)
Items Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
required
string or null (DateTime)
required
string or null (DateTime)
name
required
string
primary_language
required
string (ContentLanguage)
Enum: "alq" "ar" "bg" "buc" "ca" "cs" "cy" "da" "de" "el" "en" "en-GB" "es" "eu" "fa" "fi" "fj" "fo" "fr" "ga" "haw" "he" "hi" "hmn" "hr" "ht" "hu" "hy" "id" "is" "it" "iu" "ja" "ka" "kk" "ko" "lkt" "lld" "lo" "lt" "lv" "mh" "mi" "ms" "ne" "nl" "no" "oji" "pa" "pap" "pl" "pt" "pt-BR" "ro" "ru" "see" "sm" "so" "st" "sv" "swb" "ta" "th" "tl" "tn" "to" "tr" "uk" "vi" "xh" "zh-Hans" "zh-Hant" "zu"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

header_layout
string
Enum: "image_and_title" "image" "none" "short" "tall"
integer or null
integer or null
integer or null
integer or null
integer or null
type
string
Value: "story"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "translated_languages": [
    ],
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "name": "string",
  • "primary_language": "alq",
  • "title": {
    },
  • "short_title": {
    },
  • "stqry_directory_short_description": {
    },
  • "stqry_directory_full_description": {
    },
  • "header_layout": "image_and_title",
  • "cover_image_media_item_id": 0,
  • "cover_image_grid_media_item_id": 0,
  • "cover_image_wide_media_item_id": 0,
  • "background_image_media_item_id": 0,
  • "logo_media_item_id": 0,
  • "type": "kiosk",
  • "kiosk_id": 0,
  • "layout": "hotspots",
  • "map_id": 0,
  • "page_type": "URL",
  • "scrolling": "none",
  • "webpackage_media_item_id": 0,
  • "settings": {
    },
  • "url": {
    },
  • "html": {
    },
  • "css": {
    }
}

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Deletes an existing screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole screen)

Responses

Response samples

Content type
application/json
{
  • "screen": {
    }
}

Get appears_in graph for a Screen

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the Screen

Responses

Response samples

Content type
application/json
{
  • "screens": [
    ],
  • "collections": [
    ],
  • "media_items": [
    ],
  • "project_tabs": [
    ],
  • "quizzes": [
    ],
  • "quiz_questions": [
    ],
  • "quiz_answers": [
    ],
  • "app_listings": [
    ],
  • "in_app_purchases": [
    ],
  • "products": [
    ],
  • "map_layers": [
    ],
  • "projects": [
    ],
  • "badges": [
    ],
  • "linked_items": [
    ],
  • "playlist_items": [
    ]
}

StorySectionBadgeItems

Returns a list of badge items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of badge items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of badge item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to update

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing badge item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to update

Request Body schema: application/json
required

StorySectionBadgeItem

integer or null
integer or null
position
integer

Responses

Request samples

Content type
application/json
{
  • "badge_id": 0,
  • "badge_group_id": 0,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing badge item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single badge item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionBadgeItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySectionLinkItems

Returns a list of link items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
string or null
integer or null
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": {
    },
  • "url": {
    },
  • "username": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of link items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of link item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to update

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
string or null
integer or null
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": {
    },
  • "url": {
    },
  • "username": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing link item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to update

Request Body schema: application/json
required

StorySectionLinkItem

link_type
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky" "internal" "url" "email" "phone" "live_tours" "settings" "badges" "favourites" "download" "app_rating" "search"
icon_type
string
Enum: "media_item" "stock_icon" "clear"
stock_icon
string
string or null
integer or null
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "link_type": "twitter",
  • "icon_type": "media_item",
  • "stock_icon": "string",
  • "item_type": "Bundle",
  • "item_id": 0,
  • "position": 0,
  • "link_text": {
    },
  • "url": {
    },
  • "username": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing link item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single link item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionLinkItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySectionMediaItems

Returns a list of media items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of media items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of media item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to update

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing media item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to update

Request Body schema: application/json
required

StorySectionMediaItem

integer or null
integer or null
auto_play
boolean
position
integer

Responses

Request samples

Content type
application/json
{
  • "media_item_id": 0,
  • "start_time": 0,
  • "auto_play": true,
  • "position": 0
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing media item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single media item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionMediaItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySectionOpeningTimeItems

Returns a list of opening time items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": {
    },
  • "time": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of opening-time items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of opening-time item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to update

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": {
    },
  • "time": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing opening time item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to update

Request Body schema: application/json
required

StorySectionOpeningTimeItem

position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "position": 0,
  • "description": {
    },
  • "time": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing opening time item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single opening-time item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionOpeningTimeItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySectionPriceItems

Returns a list of price items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of price items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of price item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to update

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing price item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to update

Request Body schema: application/json
required

StorySectionPriceItem

price_cents
integer
price_currency
string
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "price_cents": 0,
  • "price_currency": "string",
  • "position": 0,
  • "description": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing price item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single price item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionPriceItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySectionSocialItems

Returns a list of social items for a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Creates a new social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": {
    },
  • "link_text": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates the positions of social items within a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of social item position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Updates an existing social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to update

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": {
    },
  • "link_text": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Updates an existing social item in a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to update

Request Body schema: application/json
required

StorySectionSocialItem

social_network
string
Enum: "twitter" "whatsapp" "wechat" "facebook" "instagram" "pinterest" "youtube" "vimeo" "linkedin" "tiktok" "weibo" "bluesky"
position
integer
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "social_network": "twitter",
  • "position": 0,
  • "username": {
    },
  • "link_text": {
    }
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Deletes an existing social item from a story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single social item

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

story_section_id
required
integer

ID of the parent StorySection

id
required
integer

ID of the StorySectionSocialItem to retrieve

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

StorySections

Returns a list of story sections for a screen

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "story_sections": [
    ]
}

Creates a new story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": {
    },
  • "hide": {
    },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates the positions of story sections within a screen

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

Request Body schema: application/json
required

Positions to update

required
Array of objects

Array of story section position updates

Responses

Request samples

Content type
application/json
{
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Returns a single story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to retrieve

Responses

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to update

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": {
    },
  • "hide": {
    },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Updates an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to update

Request Body schema: application/json
required

StorySection

One of
id
required
integer
required
string or null (DateTime)
required
string or null (DateTime)
position
required
integer
collapsable
required
boolean
exposable_content
required
boolean
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

type
string
Value: "text"
object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

object (TranslatedString)

A locale map of translated strings keyed by language code (e.g. { "en": "Hello", "fr": "Bonjour" })

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2017-07-21T17:32:28Z",
  • "updated_at": "2017-07-21T17:32:28Z",
  • "position": 0,
  • "collapsable": true,
  • "exposable_content": true,
  • "title": {
    },
  • "hide": {
    },
  • "type": "opening_time_group",
  • "opening_time_items": [
    ]
}

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Deletes an existing story section

Authorizations:
ApiKeyAuth
path Parameters
screen_id
required
integer

ID of the parent Screen

id
required
integer

ID of the StorySection to delete

query Parameters
language
string

Language locale to delete (deletes only that translation instead of the whole story section)

Responses

Response samples

Content type
application/json
{
  • "story_section": {
    }
}

Triggers

Returns a list of triggers for a badge

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "triggers": [
    ]
}

Creates a new trigger

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

Request Body schema: application/json
required

Trigger

trigger_type
string
Enum: "off" "quiz_question" "screen" "gps" "beacon"

How the badge is awarded. 'screen'/'quiz_question' require a matching triggerable; 'gps'/'beacon' use the corresponding settings; 'off' disables the trigger.

string or null
integer or null
GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "trigger_type": "off",
  • "triggerable_type": "QuizQuestion",
  • "triggerable_id": 0,
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

Returns a single trigger

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

id
required
integer

ID of the Trigger to retrieve

Responses

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

Updates an existing trigger

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

id
required
integer

ID of the Trigger to update

Request Body schema: application/json
required

Trigger

trigger_type
string
Enum: "off" "quiz_question" "screen" "gps" "beacon"

How the badge is awarded. 'screen'/'quiz_question' require a matching triggerable; 'gps'/'beacon' use the corresponding settings; 'off' disables the trigger.

string or null
integer or null
GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "trigger_type": "off",
  • "triggerable_type": "QuizQuestion",
  • "triggerable_id": 0,
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

Updates an existing trigger

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

id
required
integer

ID of the Trigger to update

Request Body schema: application/json
required

Trigger

trigger_type
string
Enum: "off" "quiz_question" "screen" "gps" "beacon"

How the badge is awarded. 'screen'/'quiz_question' require a matching triggerable; 'gps'/'beacon' use the corresponding settings; 'off' disables the trigger.

string or null
integer or null
GpsSettings (object) or null
BeaconSettings (object) or null

Responses

Request samples

Content type
application/json
{
  • "trigger_type": "off",
  • "triggerable_type": "QuizQuestion",
  • "triggerable_id": 0,
  • "gps_settings": {
    },
  • "beacon_settings": {
    }
}

Response samples

Content type
application/json
{
  • "trigger": {
    }
}

Deletes an existing trigger

Authorizations:
ApiKeyAuth
path Parameters
badge_group_id
required
integer

ID of the parent BadgeGroup

badge_id
required
integer

ID of the parent Badge

id
required
integer

ID of the Trigger to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

UploadedFiles

Returns a list of uploaded files for an account

Authorizations:
ApiKeyAuth
query Parameters
page
integer

Page number

per_page
integer [ 1 .. 1000 ]
Default: 30

Number of items per page, max 1000

sort_field
string
Enum: "id" "upload_file_name" "created_at" "updated_at"

Field to sort by

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"

Direction to sort by

q
string

Search query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "uploaded_files": [
    ]
}

Creates a new uploaded file record

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Returns a presigned URL for uploading a file to S3

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Presigned URL request

filename
required
string

The filename to upload

Responses

Request samples

Content type
application/json
{
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "fields": { }
}

Enqueues a file from S3 for processing

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Process enqueue request

s3_url
required
string

The S3 URL of the file to process

subtype
string

File subtype (e.g. map, geo_map)

focal_point
string

Focal point coordinates (e.g. 0.5,0.5)

Responses

Request samples

Content type
application/json
{
  • "s3_url": "string",
  • "subtype": "string",
  • "focal_point": "string"
}

Response samples

Content type
application/json
{
  • "job_id": "string"
}

Returns the status of a file processing job

Authorizations:
ApiKeyAuth
path Parameters
job_id
required
string

The Sidekiq job ID returned from process_enqueue

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "at": 0,
  • "pct_complete": 0,
  • "message": "string",
  • "uploaded_file": {
    }
}

Returns a single uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to retrieve

Responses

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Updates an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to update

Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Updates an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to update

Request Body schema: application/json
required

UploadedFile

filename
string
content_type
string
file_size
integer
file_hash
string
integer or null
integer or null
integer or null
status
string
Enum: "ready" "transcoder_started" "transcoder_invalid_file" "transcoder_error" "transcoder_submitted" "transcoder_progressing" "transcoder_canceled" "transcoder_complete" "mbtiles_started" "unzip_started" "unzip_complete" "mbtiles_downloading" "mbtiles_to_geotiff" "mbtiles_to_mbtiles" "mbtiles_upload_png" "mbtiles_upload_png8" "mbtiles_upload_jpeg" "mbtiles_complete"
focal_point
object

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "content_type": "string",
  • "file_size": 0,
  • "file_hash": "string",
  • "width": 0,
  • "height": 0,
  • "duration": 0,
  • "status": "ready",
  • "focal_point": { }
}

Response samples

Content type
application/json
{
  • "uploaded_file": {
    }
}

Deletes an existing uploaded file

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of the UploadedFile to delete

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

stqry