README.md

//:

"Redirect: https://github.com/AlpacaTravel/graphql-docs/tree/master/reference"

Schema Types

Table of Contents

• Query
• Mutation
• Objects
  • ApproveProfileFollowPayload
  • Attribute
  • AttributeConnection
  • AttributeEdge
  • BeginMutationSessionPayload
  • BillingAddress
  • BillingDetails
  • BillingPlan
  • BillingPrice
  • BillingPriceConnection
  • BillingPriceEdge
  • BillingPriceRecurring
  • BillingProduct
  • BillingSubscription
  • BillingSubscriptionConnection
  • BillingSubscriptionEdge
  • Bounds
  • CaptureMarketingInformationPayload
  • ChangeItineraryDefaultLocalePayload
  • ClaimProfileHandlePayload
  • Collection
  • CollectionConnection
  • CollectionEdge
  • CollectionItemConnection
  • CollectionItemEdge
  • CollectionItemFailedToLoad
  • CollectionLocation
  • ConnectedApp
  • ConnectedAppConnection
  • ConnectedAppEdge
  • CreateBillingCheckoutSessionOutput
  • CreateBillingPortalSessionOutput
  • CreateCollectionLocationPayload
  • CreateCollectionPayload
  • CreateConnectedAppPayload
  • CreateIconSilhouettePayload
  • CreateItineraryCollectionPayload
  • CreateItineraryDirectionsPayload
  • CreateItineraryLinkCollectionLocationPayload
  • CreateItineraryLinkItineraryPayload
  • CreateItineraryLocationPayload
  • CreateItineraryPayload
  • CreateItinerarySegmentPayload
  • CreateProfilePayload
  • CreateUserAgreementPayload
  • DeleteCollectionItemPayload
  • DeleteCollectionPayload
  • DeleteConnectedAppPayload
  • DeleteIconResourcePayload
  • DeleteItineraryItemPayload
  • DeleteItineraryPayload
  • DeleteProfilePayload
  • DenyProfileFollowPayload
  • DuplicateItineraryPayload
  • Elevation
  • EndMutationSessionPayload
  • FinalizeMediaUploadPayload
  • FollowProfilePayload
  • IconComposition
  • IconCompositionConnection
  • IconCompositionEdge
  • IconResourceConnection
  • IconResourceEdge
  • IconResourceFailedToLoad
  • IconSilhouette
  • Isochrone
  • Itinerary
  • ItineraryAutoRoute
  • ItineraryCollection
  • ItineraryDirections
  • ItineraryDirectionsConnection
  • ItineraryDirectionsDurations
  • ItineraryDirectionsEdge
  • ItineraryFailedToLoad
  • ItineraryItemCascadedChanges
  • ItineraryItemConnection
  • ItineraryItemEdge
  • ItineraryLinkCollectionLocation
  • ItineraryLinkItinerary
  • ItineraryLocation
  • ItinerarySearchConnection
  • ItinerarySearchEdge
  • ItinerarySearchNode
  • ItinerarySegment
  • MediaContainer
  • MediaContainerConnection
  • MediaContainerEdge
  • MediaImage
  • MediaImageExif
  • MediaImageSource
  • MediaResourceFailedToLoad
  • MoveItineraryItemPayload
  • MutationSession
  • PageInfo
  • Place
  • PlaceAddress
  • PlaceAttribution
  • PlaceContact
  • PlaceFrom
  • PlaceHours
  • PlaceHoursForDay
  • PlaceHoursInterval
  • PlaceHoursIntervalConnection
  • PlaceHoursIntervalEdge
  • PlaceHoursIntervalHoliday
  • PlaceLayer
  • PlaceSearchConnection
  • PlaceSearchEdge
  • PlaceSearchNode
  • PlaceTowards
  • Position
  • PositionFrom
  • PositionTowards
  • Profile
  • ProfileConnection
  • ProfileEdge
  • ProfileFollowConnection
  • ProfileFollowEdge
  • PublishItineraryPayload
  • ResolutionError
  • RevertItineraryPayload
  • Route
  • RouteConnection
  • RouteEdge
  • RouteSegment
  • StartMediaUploadPayload
  • TextSearchResult
  • TextSearchResultMatch
  • UnfollowProfilePayload
  • UpdateBillingDetailsOutput
  • UpdateCollectionLocationPayload
  • UpdateCollectionPayload
  • UpdateConnectedAppPayload
  • UpdateIconSilhouettePayload
  • UpdateItineraryCollectionPayload
  • UpdateItineraryDirectionsPayload
  • UpdateItineraryLinkCollectionLocationPayload
  • UpdateItineraryLinkItineraryPayload
  • UpdateItineraryLocationPayload
  • UpdateItineraryPayload
  • UpdateItinerarySegmentPayload
  • UpdateMediaResourcePayload
  • UpdateProfilePayload
  • UserAgreement
  • UserAgreementConnection
  • UserAgreementEdge
• Inputs
  • AttributeIdentifierInput
  • AttributeInput
  • BillingAddressInput
  • BillingPriceInput
  • BoundsCircleInput
  • BoundsInput
  • CollectionItemsSort
  • CollectionsSort
  • CreateCollectionInput
  • CreateCollectionLocationInput
  • CreateConnectedAppInput
  • CreateIconCompositionInput
  • CreateIconSilhouetteInput
  • CreateItineraryCollectionInput
  • CreateItineraryDirectionsInput
  • CreateItineraryInput
  • CreateItineraryLinkCollectionLocationInput
  • CreateItineraryLinkItineraryInput
  • CreateItineraryLocationInput
  • CreateItinerarySegmentInput
  • CreateMediaContainerInput
  • CreateProfileInput
  • CreateUserAgreementInput
  • DatetimeOffset
  • ElevationInput
  • FinalizeMediaUploadInput
  • GeoJsonSimplification
  • GeoJsonSimplificationRamerDouglasPeucker
  • ItinerariesSort
  • ItineraryAutoRouteInput
  • ItineraryDirectionsDurationsInput
  • ItineraryItemPositionAfterSibling
  • ItineraryItemPositionAtEnd
  • ItineraryItemPositionAtStart
  • ItineraryItemPositionBeforeSibling
  • ItineraryItemPositionOnLastCollection
  • MediaContainerInput
  • MediaContainerPositionAfter
  • MediaContainerPositionAtEnd
  • MediaContainerPositionAtStart
  • MediaContainerPositionBefore
  • MoveMediaContainerInput
  • PlaceInput
  • PositionInput
  • RouteInput
  • RouteSegmentInput
  • UpdateBillingDetailsInput
  • UpdateCollectionInput
  • UpdateCollectionLocationInput
  • UpdateConnectedAppInput
  • UpdateIconCompositionInput
  • UpdateIconSilhouetteInput
  • UpdateItineraryCollectionInput
  • UpdateItineraryDirectionsInput
  • UpdateItineraryInput
  • UpdateItineraryLinkCollectionLocationInput
  • UpdateItineraryLinkItineraryInput
  • UpdateItineraryLocationInput
  • UpdateItinerarySegmentInput
  • UpdateMediaContainerInput
  • UpdateMediaResourceInput
  • UpdateProfileInput
• Enums
  • AngleUnit
  • BeginMutationSessionResult
  • BillingPriceRecurringInterval
  • BillingSubscriptionStatus
  • CollectionDiscriminator
  • CompassPoint
  • ConnectedAppAuthType
  • ConnectedAppServiceKey
  • ConnectedAppType
  • DistanceUnit
  • DurationUnit
  • IsochroneMode
  • ItineraryDirectionsAccuracy
  • ItineraryDirectionsDirection
  • ItineraryDirectionsRestrict
  • ItineraryItemType
  • MediaUploadStatus
  • PlaceHoursStatus
  • PlaceNavigationUrlProvider
  • PlaceSearchSource
  • ProfileFollowStatus
  • ProfileType
  • RouteMode
  • RouteSearchableMode
  • SortDirection
• Scalars
  • Boolean
  • Float
  • ID
  • Int
  • JSON
  • String
• Interfaces
  • CollectionItem
  • IconResource
  • ItineraryItem
  • ItineraryLink
  • MediaResource
  • Node

Query

Field	Argument	Type	Description
node		Node	Get a resource that implements Node by id
id		ID!	The unique identifier of the resource
collection		Collection	Retrieve a collection by id
id		ID!	The unique identifier of the collection
collections		CollectionConnection!	Retrieve multiple collections
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID!	Filter by the profile owner of the collection
discriminator		String	Filter by the collection's discriminator
sort		[CollectionsSort!]	Sort result by given field. Results can be sorted only by one field
collectionItem		CollectionItem	Retrieve a collection item by id
id		ID!	The unique identifier of the collection item
collectionItems		CollectionItemConnection!	Retrieve multiple collection items filtered by different criteria
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID	Filter by the profile owner of the item
collectionIds		[ID!]	Filter by the collections that items are associated to
keyword		String	Filter by a supplied keyword, checking the title, synopsis, description and tags of items
tags		[String!]	Filter by the tags that are applied to the item
sectionIds		[ID!]	Filter by the collection sections that the items are associated to
resourceIds		[ID!]	Filter by the resource identifiers that the items are associated to
placeIds		[ID!]	Filter by the resource identifiers that the items are associated to
boundsCircle		BoundsCircleInput	A bounding circle that the item positions must fall within
bounds		BoundsInput	A bounding box that the item positions must fall within
externalIds		[ID!]	Filter by the custom/external-ref attribute of the items
externalSources		[ID!]	Filter by the custom/external-source attribute of the items
sort		[CollectionItemsSort!]	Sort result by given field. Results can be sorted only by one field
connectedApp		ConnectedApp	Obtains a connected app by a provided id
id		ID!	The unique identifier of the connected-app
connectedApps		ConnectedAppConnection!	Search connected apps
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID!	Filter by the profile owner of the connected-app
deleted		Boolean	Return only deleted applications
expired		Boolean	Return only expired applications
type		ConnectedAppType	Filter by the app's type
authType		ConnectedAppAuthType	Filter by the app's authorization type
serviceKey		ConnectedAppServiceKey	Filter by the app's service key
iconResource		IconResource	Obtains an IconResource with a provided id
id		ID!	The unique identifier of the IconResource
iconResources		IconResourceConnection!	Retrieve multiple IconResources under a profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID!	Filter by the profile owner of the IconResources
isochrone		[Isochrone!]!	Query for fetching isochrone
center		PositionInput!	The center (starting point) of the isochrone
duration		Int!	The duration of the isochrone in minutes
mode		IsochroneMode!	The mode of transport of the isochrone
itinerary		Itinerary	Get an itinerary by id
id		ID!	The unique identifier of the itinerary
itineraries		ItinerarySearchConnection!	Query itineraries that belong to a profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID!	Filter by the profile owner of the itienrary
keyword		String	Filter by a supplied keyword, checking the title, synopsis, description and tags of itineraries
sort		[ItinerariesSort!]	Sort result by given field. Results can be sorted only by one field
routes		RouteConnection!	Look up routes for traveling along the given positions
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
positions		[PositionInput!]!	The positions the route should visit
mode		RouteSearchableMode!	The mode of transport of the route
mediaContainer		MediaContainer	Retrieve a MediaContainer by id
id		ID!	The unique identifier of the MediaContainer
mediaResource		MediaResource	Retrieve a MediaResource by id
id		ID!	The unique identifier of the MediaResource
place		Place	Get a place by id
id		ID!	The unique identifier of the place
places		[Place]!	Get multiple places by id
ids		[ID!]!	List of unique place identifiers
placeSearch		PlaceSearchConnection!	Search for places
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
text		String	Filter places by a text query
focus		PositionInput	A focus point that the places should be close to
bounds		BoundsInput	A bounding box that the item positions must fall within
sources		[PlaceSearchSource!]	The place sources to search
layers		[String!]	The place layers to search
thirdPartyQuery		JSON	Additional third-party specific arguments
maxLabelLength		Int	Maximum text length for search results labels
placeAutocompleteSearch		PlaceSearchConnection!	Autocomplete for place search
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
text		String!	Filter places by a text query
focus		PositionInput	A focus point that the places should be close to
bounds		BoundsInput	A bounding box that the item positions must fall within
sources		[PlaceSearchSource!]	The place sources to search
layers		[String!]	The place layers to search
thirdPartyQuery		JSON	Additional third-party specific arguments
maxLabelLength		Int	Maximum text length for search results labels
placeAddressSearch		PlaceSearchConnection!	Search for places based on address details
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
borough		String	Filter by borough
country		String	Filter by country
county		String	Filter by county
locality		String	Filter by locality
neighbourhood		String	Filter by neighbourhood
postalCode		String	Filter by postalCode
region		String	Filter by region
streetAddress		String	Filter by streetAddress
sources		[PlaceSearchSource!]	The place sources to search
layers		[String!]	The place layers to search
thirdPartyQuery		JSON	Additional third-party specific arguments
maxLabelLength		Int	Maximum text length for search results labels
placeReverseSearch		PlaceSearchConnection!	Search for places by location
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
focus		PositionInput!	A focus point that the places should be close to
sources		[PlaceSearchSource!]	The place sources to search
layers		[String!]	The place layers to search
thirdPartyQuery		JSON	Additional third-party specific arguments
maxLabelLength		Int	Maximum text length for search results labels
profile		Profile	Obtains a profile by a provided id
id		ID!	The unique identifier of the profile to fetch
profileByHandle		Profile	Obtains a profile with the provided handle
handle		String!	The unique handle of the profile to fetch
authorizedProfiles		ProfileConnection!	Look up all authorised profiles
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profiles		ProfileConnection!	Search profiles
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
handle		String!	Filter by profile handle
billingPrices		BillingPriceConnection!	List of available billing prices
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
billingSubscriptions		BillingSubscriptionConnection!	Fetch billing subscriptions associated with a profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID!	The profile id
billingDetails		BillingDetails	Fetch billing details associated with a profile
profileId		ID!	The profile id
userAgreements		UserAgreementConnection!	Query for fetching agreements made by this user
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
profileId		ID	Filter by the profile associated with the agreement
mutationSession		MutationSession	Get the mutation session for a given resource
resourceId		ID!	The ID of the resource to get the mutation session for

Mutation

Field	Argument	Type	Description
createCollection		CreateCollectionPayload!	The return fields available after creating a collection
profileId		ID!	The identifier of the profile that will own the new collection
collection		CreateCollectionInput!	The new collection
updateCollection		UpdateCollectionPayload!	Updates a collection
id		ID!	The id of the collection to update
collection		UpdateCollectionInput!	The updated collection data
deleteCollection		DeleteCollectionPayload!	Delete an collection
id		ID!	The id of the collection to delete
deleteCollectionItem		DeleteCollectionItemPayload!	The fields available after the collection is deleted
id		ID!	The ID of the collection deleted
createCollectionLocation		CreateCollectionLocationPayload!	Create a new collection-location under the given collection
collectionId		ID!	The collection ID to associate this collection item to, in the form of collection/XYZ
location		CreateCollectionLocationInput!	The collection location to be created
updateCollectionLocation		UpdateCollectionLocationPayload!	The fields avaialble after updating the collection location
id		ID!	The id of the collection location updated
location		UpdateCollectionLocationInput!	The updated collection location
createConnectedApp		CreateConnectedAppPayload!	The return fields available after creating a connected app
profileId		ID!	The identifier of the profile that will own the new connected-app
connectedApp		CreateConnectedAppInput!	The new connected-app
updateConnectedApp		UpdateConnectedAppPayload!	Update a connected app
id		ID!	The id of the connected-app to update
connectedApp		UpdateConnectedAppInput!	The updated connected-app data
deleteConnectedApp		DeleteConnectedAppPayload!	Deleted a connected app
id		ID!	The id of the connected app to delete
createIconSilhouette		CreateIconSilhouettePayload!	Creates a new icon
profileId		ID!	The identifier of the profile that will own the new IconSilhouette
icon		CreateIconSilhouetteInput!	The new IconSilhouette
updateIconSilhouette		UpdateIconSilhouettePayload!	Updates a icon
id		ID!	The id of the icon to update
icon		UpdateIconSilhouetteInput!	The updated icon
deleteIconResource		DeleteIconResourcePayload!	Delete an icon
id		ID!	The id of the icon to delete
moveItineraryItem		MoveItineraryItemPayload!	Move an ItineraryItem
id		ID!	The itinerary item identifier, in the form of item/XYZ
positionAtStart		ItineraryItemPositionAtStart	Moves the item to be before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Moves the item to be after all of its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Moves the item after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Moves the item before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Moves the item to the last position of the last itinerary-collection item
publish		Boolean!	If set to true, the mutation will be automatically published.
deleteItineraryItem		DeleteItineraryItemPayload!	Delete an ItineraryItem
id		ID!	The itinerary item identifier of the removed item
publish		Boolean!	If set to true, the mutation will be automatically published.
createItinerary		CreateItineraryPayload!	Create a new itinerary
itinerary		CreateItineraryInput!	The new itinerary
profileId		ID	The id of the profile that will own the created itinerary Omit to create an anonymous itinerary
publish		Boolean!	If set to true, the new itinerary will be automatically published.
updateItinerary		UpdateItineraryPayload!	Updates a itinerary
id		ID!	The id of the itinerary to update
itinerary		UpdateItineraryInput!	The fields to update on the itinerary
publish		Boolean!	If set to true, the mutation will be automatically published.
deleteItinerary		DeleteItineraryPayload!	Delete an itinerary
id		ID!	The id of the itinerary to delete
publishItinerary		PublishItineraryPayload!	Publish an itinerary making it publically accessible
id		ID!	The id of the itinerary to publish
revertItinerary		PublishItineraryPayload!	Revert the draft version of an itinerary to last published version
id		ID!	The id of the itinerary to revert
duplicateItinerary		DuplicateItineraryPayload!	Duplicate an itinerary, creating copy with a new id
id		ID!	The id of the itinerary to duplicate
changeItineraryDefaultLocale		DuplicateItineraryPayload!	Change the itinerary's default-locale as well the locale of attributes with the previous default-locale
id		ID!	The id of the itinerary to duplicate
defaultLocale		String!	The new default locale for this itinerary
createItineraryCollection		CreateItineraryCollectionPayload!	Create a new ItineraryCollection item inside the given itinerary
itineraryId		ID!	The itinerary identifier for this itinerary collection to be created within, in the form of itinerary/XYZ
collection		CreateItineraryCollectionInput!	The fields for creating the itinerary collection
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItineraryCollection		UpdateItineraryCollectionPayload!	Update an ItineraryCollection
id		ID!	The itinerary collection identifier, in the form of item/XYZ
collection		UpdateItineraryCollectionInput!	The fields to update on the itinerary collection
publish		Boolean!	If set to true, the mutation will be automatically published.
createItineraryLocation		CreateItineraryLocationPayload!	Create a new ItineraryLocation item inside the given itinerary
itineraryId		ID!	The itinerary identifier, in the form of itinerary/XYZ
location		CreateItineraryLocationInput!	The input fields for creating the itinerary location
autoRoute		RouteSegmentInput	Modify the first segment of the route automatically created by autoRoute when creating an ItineraryLocation
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItineraryLocation		UpdateItineraryLocationPayload!	Update an ItineraryLocation
id		ID!	The itinerary location identifier, in the form of item/XYZ
location		UpdateItineraryLocationInput!	The fields for updating the itinerary location
publish		Boolean!	If set to true, the mutation will be automatically published.
createItineraryDirections		CreateItineraryDirectionsPayload!	Create a new ItineraryDirections item inside the given itinerary
itineraryId		ID!	The itinerary identifier, in the form of itinerary/XYZ
directions		CreateItineraryDirectionsInput!	The directions input fields
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItineraryDirections		UpdateItineraryDirectionsPayload!	Update an ItineraryDirections
id		ID!	The itinerary directions identifier, in the form of item/XYZ
directions		UpdateItineraryDirectionsInput!	The fields to update on the itinerary directions item
publish		Boolean!	If set to true, the mutation will be automatically published.
createItinerarySegment		CreateItinerarySegmentPayload!	Create a new ItinerarySegment item inside the given itinerary
itineraryId		ID!	The itinerary identifier for this itinerary segment to be created within, in the form of itinerary/XYZ
segment		CreateItinerarySegmentInput!	The fields for creating the itinerary segment
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItinerarySegment		UpdateItinerarySegmentPayload!	Update an ItinerarySegment
id		ID!	The itinerary segment identifier, in the form of item/XYZ
segment		UpdateItinerarySegmentInput!	The fields to update on the itinerary segment
publish		Boolean!	If set to true, the mutation will be automatically published.
createItineraryLinkItinerary		CreateItineraryLinkItineraryPayload!	Create a new ItineraryLinkItinerary item inside the given itinerary
itineraryId		ID!	The itinerary identifier for this itinerary link to be created within, in the form of itinerary/XYZ
link		CreateItineraryLinkItineraryInput!	The fields for creating the itinerary link
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItineraryLinkItinerary		UpdateItineraryLinkItineraryPayload!	Update an ItineraryLinkItinerary
id		ID!	The itinerary link identifier, in the form of item/XYZ
link		UpdateItineraryLinkItineraryInput!	The fields to update on the itinerary link
publish		Boolean!	If set to true, the mutation will be automatically published.
createItineraryLinkCollectionLocation		CreateItineraryLinkCollectionLocationPayload!	Create a new ItineraryLinkCollectionLocation item inside the given itinerary
itineraryId		ID!	The itinerary identifier for this itinerary link to be created within, in the form of itinerary/XYZ
link		CreateItineraryLinkCollectionLocationInput!	The fields for creating the itinerary link
publish		Boolean!	If set to true, the mutation will be automatically published.
updateItineraryLinkCollectionLocation		UpdateItineraryLinkCollectionLocationPayload!	Update an ItineraryLinkCollectionLocation
id		ID!	The itinerary link identifier, in the form of item/XYZ
link		UpdateItineraryLinkCollectionLocationInput!	The fields to update on the itinerary link
publish		Boolean!	If set to true, the mutation will be automatically published.
startMediaUpload		StartMediaUploadPayload!	Start a media upload
filename		String!	The file name of the media file that will be uploaded
contentType		String	The content type of the media file that will be uploaded
finalizeMediaUpload		FinalizeMediaUploadPayload!	Finalize the media upload by creating a media-resource
token		String!	The upload token returned by Mutation.startMediaUpload
profileId		ID	The identifier of the profile that will own the new media-resource
resource		FinalizeMediaUploadInput	Details of the new media-resource
updateMediaResource		UpdateMediaResourcePayload!	Update a media resource with updated properties
id		ID!	The id of the media resource to update
resource		UpdateMediaResourceInput!	The fields to update on the media-resource
followProfile		FollowProfilePayload!	Create a follow request between two profiles
fromProfileId		ID!	The follower profile
toProfileId		ID!	The profile being followed
unfollowProfile		UnfollowProfilePayload!	Remove the follow between two profiles
fromProfileId		ID!	The follower profile
toProfileId		ID!	The profile being followed
approveProfileFollow		ApproveProfileFollowPayload!	Approve a follow request between two profiles
fromProfileId		ID!	The follower profile
toProfileId		ID!	The profile being followed
denyProfileFollow		DenyProfileFollowPayload!	Deny a follow request between two profiles
fromProfileId		ID!	The follower profile
toProfileId		ID!	The profile being followed
claimProfileHandle		ClaimProfileHandlePayload!	Claim an unclaimed handle for the given profile
id		ID!	The unique identifier of the profile that will claim the handle
handle		String!	The handle to claim
createProfile		CreateProfilePayload!	Creates a new profile with the given fields. Can only be called with a bearer token.
profile		CreateProfileInput!	The fields to set on the new profile
updateProfile		UpdateProfilePayload!	Updates the specified profile with the given fields
id		ID!	The id of the profile to update
profile		UpdateProfileInput!	The fields to update on the profile
deleteProfile		DeleteProfilePayload!	Delete a profile
id		ID!	The id of the itinerary to delete
captureMarketingInformation		CaptureMarketingInformationPayload!	Capture marketing information against the given profile
profileId		ID!	The id of the profile to associate the information against
name		String
organizationType		String
intendedUses		String
leadSource		String
updateBillingDetails		UpdateBillingDetailsOutput!	Update the billing details associated with a profile
profileId		ID!	The identifier of the profile the billing details apply to
billingDetails		UpdateBillingDetailsInput!	The updated billing details
createBillingCheckoutSession		CreateBillingCheckoutSessionOutput!	Create a billing checkout session
profileId		ID!	The identifier of the profile the billing details apply to
successUrl		String!	Redirect url on success
cancelUrl		String!	Redirect url on cancel
prices		[BillingPriceInput!]!	The prices to checkout with
createBillingPortalSession		CreateBillingPortalSessionOutput!	Create a billing portal session
profileId		ID!	The identifier of the profile the billing details apply to
returnUrl		String!	Redirect url to return to
createUserAgreement		CreateUserAgreementPayload!	The return fields available after creating a user agreement
profileId		ID	The identifier of the profile that will be associated with the agreement
userAgreement		CreateUserAgreementInput!	The new user agreement
beginMutationSession		BeginMutationSessionPayload!	Begin a mutation session for a given resource, or extend it if one belonging to the user already exists
resourceId		ID!	The ID of the resource to begin a mutation session for
force		Boolean!	Whether to force the session if it is already taken
endMutationSession		EndMutationSessionPayload!	End the mutation session for a given resource if one belonging to the user exists
resourceId		ID!	The ID of the resource to end a mutation session for

Objects

ApproveProfileFollowPayload

Result of approving a follow request

Field	Argument	Type	Description
fromProfile		Profile!	The follower profile
toProfile		Profile!	The profile being followed
status		ProfileFollowStatus	The status of the follow request

Attribute

Additional data defined on a resource

Field	Argument	Type	Description
id		ID!	The attribute identifier Has the form "{{resource_type}}/{{attribute_name}}" eg: The "title" attribute on an item will have the id: "item/title" Custom attributes have the form "custom/{{attribute_name}}"
value		JSON	The attribute value, can be any JSON-serialisable type
meta		JSON	Optional attribute metadata, can be any JSON-serialisable type
locale		String	Optional string representing the locale of the attribute value

AttributeConnection

Connection of Attributes

Field	Argument	Type	Description
edges		[AttributeEdge!]!	All the edges in this page of the connection
nodes		[Attribute!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

AttributeEdge

Edge containing a Attribute

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		Attribute!	The item

BeginMutationSessionPayload

The MutationSession that was created or extended

Field	Argument	Type	Description
result		BeginMutationSessionResult!	The result of the mutation
mutationSession		MutationSession!	The newly created mutation session

BillingAddress

The address field of a BillingDetails object

Field	Argument	Type	Description
addressLineOne		String!
addressLineTwo		String
locality		String!
region		String!
postalCode		String
countryCode		String!

BillingDetails

Billing details associated with a profile

Field	Argument	Type	Description
profile		Profile!	Profile that these billing details apply to
emailAddress		String!	The email address
givenName		String!	The given name
familyName		String!	The family name
organization		String	The optional organization name
address		BillingAddress!	The billing address

BillingPlan

A billing plan

Field	Argument	Type	Description
id		ID!	The identifier for this plan
quantity		Int!	The quantity
price		BillingPrice	The price of this plan

BillingPrice

A price available for a billing plan

Field	Argument	Type	Description
id		ID!	The unique id for this price
product		BillingProduct!	The product corres
currency		String!	The currency used for this price
amount		Int!	The amount of this price
recurring		BillingPriceRecurring!	Recurrence details of the price

BillingPriceConnection

Connection of BillingPrices

Field	Argument	Type	Description
edges		[BillingPriceEdge!]!	All the edges in this page of the connection
nodes		[BillingPrice!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

BillingPriceEdge

Edge containing a BillingPrice

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		BillingPrice!	The item

BillingPriceRecurring

The recurrence details for a BillingPrice

Field	Argument	Type	Description
interval		BillingPriceRecurringInterval!	The interval type
count		Int!	The number of interval per recurrence

BillingProduct

A product corresponding to a price

Field	Argument	Type	Description
id		ID!	The unique id for this product
name		String!	The name of this product
description		String	The description for this product

BillingSubscription

A billing subscription

Field	Argument	Type	Description
id		ID!	The unique id for this subscription
profile		Profile!	Profile that this billing subscription belongs to
status		BillingSubscriptionStatus!	The current status of this subscription
created		String!	The date when the subscription was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String!	The date when the subscription was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
plans		[BillingPlan!]!	The plans attached to this subscription

BillingSubscriptionConnection

Connection of BillingSubscriptions

Field	Argument	Type	Description
edges		[BillingSubscriptionEdge!]!	All the edges in this page of the connection
nodes		[BillingSubscription!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

BillingSubscriptionEdge

Edge containing a BillingSubscription

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		BillingSubscription!	The item

Bounds

A bounding box on a map defined by two positions (opposite corners of the box)

Field	Argument	Type	Description
w		Float!	The west-most longitude of the bounding box
s		Float!	The south-most latitude of the bounding box
e		Float!	The east-most longitude of the bounding box
n		Float!	The north-most latitude of the bounding box
ws		[Float!]!	The south-west point of the bounding box in the form: [west, south]
en		[Float!]!	The north-east point of the bounding box in the form: [east, north]
wsen		[Float!]!	The south-west and north-east points of the bounding box in the form: [west, south, east, north]
minMax		[[Float!]!]!	The minimum and maximum points of the bounding box in the form: [minimum, maximum]

CaptureMarketingInformationPayload

The result of Mutation.captureMarketingInformation

Field	Argument	Type	Description
profileId		ID	The ID of the profile that the information is associated against

ChangeItineraryDefaultLocalePayload

Response to Mutation.changeItineraryDefaultLocale

Field	Argument	Type	Description
itinerary		Itinerary	The changed itinerary

ClaimProfileHandlePayload

Response of claiming a handle

Field	Argument	Type	Description
profile		Profile	The profile that will claim the handle

Collection

A collection type is used to group together a unordered set of items

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile!	Profile that owns this collection
created		String	The date when the collection was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the collection was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
title		String	A supplied title for this collection
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	A single MediaContainer representing the preferred media to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
discriminator		String!	A label used to differentiate types of collections
item		CollectionItemEmbedded	Returns an item belonging to this collection by id
id		ID!	The unique identifier of the collection item
items		CollectionItemConnection!	Retrieve multiple collection-items belonging to this collection
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
keyword		String	Filter by a supplied keyword, checking the title, synopsis, description and tags of items
tags		[String!]	Filter by the tags that are applied to the item
sectionIds		[ID!]	Filter by the collection sections that the items are associated to
resourceIds		[ID!]	Filter by the resource identifiers that the items are associated to
boundsCircle		BoundsCircleInput	A bounding circle that the item positions must fall within
bounds		BoundsInput	A bounding box that the item positions must fall within
externalIds		[ID!]	Filter by the custom/external-ref attribute of the items
externalSources		[ID!]	Filter by the custom/external-source attribute of the items
sort		[CollectionItemsSort!]	Sort result by given field. Results can be sorted only by one field

CollectionConnection

Connection of Collections

Field	Argument	Type	Description
edges		[CollectionEdge!]!	All the edges in this page of the connection
nodes		[Collection!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

CollectionEdge

Edge containing a Collection

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		Collection!	The item

CollectionItemConnection

Connection of CollectionItems

Field	Argument	Type	Description
edges		[CollectionItemEdge!]!	All the edges in this page of the connection
nodes		[CollectionItem!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

CollectionItemEdge

Edge containing a CollectionItem

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		CollectionItem!	The item

CollectionItemFailedToLoad

Represents an embedded CollectionItem that failed to load

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.

CollectionLocation

A CollectionItem used to represents a single location association to a place.

Field	Argument	Type	Description
id		ID!	The unique identifier, taking the shape of item/XYZ
profile		Profile!	The associated profile owner
created		String	The date when the collection-item was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the collection-item was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
sectionIds		[ID!]!	One or more sections this item belongs to
externalId		ID	Identifier from an external source this item is associated with
externalSource		ID	The source of the item's externalId
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
place		Place!	The associated place information for this location
position		Position!	The position of the collection-location (derived from place if not overridden)
bounds		Bounds	The bounding box around the collection-location (derived from place if not overridden)
contact		PlaceContact!	Contact information for the collection location
address		PlaceAddress!	Address information for the collection location

ConnectedApp

Connected apps stored in the profile

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile	The profile associated with this connected app
type		ConnectedAppType	A key to describe the type of connection to the application
serviceKey		ConnectedAppServiceKey!	This is the key relating to the service - it identifies the "App" we are connecting to
authType		ConnectedAppAuthType	Depending on the authentication method, this can highlight the authenticated application method (e.g. OAuth)
scope		String	Any specific scope that has been granted to the 3rd party application
privateConfiguration		JSON	Private configuration information as encrypted JSON
publicId		ID	A 3rd party ID or Account ID, this does not affect any of the Alpaca ID naming - for instance, if we are connecting to an Identity in OAUTH, this is the OAUTH Identity ID - This is just a place to store data

ConnectedAppConnection

Connection of ConnectedApps

Field	Argument	Type	Description
edges		[ConnectedAppEdge!]!	All the edges in this page of the connection
nodes		[ConnectedApp!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ConnectedAppEdge

Edge containing a ConnectedApp

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		ConnectedApp!	The item

CreateBillingCheckoutSessionOutput

The output after creating a billing checkout session

Field	Argument	Type	Description
url		String!	The url for the checkout session

CreateBillingPortalSessionOutput

The output after creating a billing portal session

Field	Argument	Type	Description
url		String!	The url for the portal session

CreateCollectionLocationPayload

The fields available to return after creating a new collection location

Field	Argument	Type	Description
location		CollectionLocation	The created collection location

CreateCollectionPayload

The return fields avaialble after creating a collection

Field	Argument	Type	Description
collection		Collection	The newly created collection

CreateConnectedAppPayload

The return fields available after creating a connected app

Field	Argument	Type	Description
connectedApp		ConnectedApp	The newly created connected-app

CreateIconSilhouettePayload

The response after creating an IconSilhouette

Field	Argument	Type	Description
icon		IconSilhouette	The newly created IconSilhouette

CreateItineraryCollectionPayload

The fields available after creating an itinerary collection

Field	Argument	Type	Description
collection		ItineraryCollection	The created itinerary collection
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-collection

CreateItineraryDirectionsPayload

The itinerary directions return fields available after creating the itinerary directions

Field	Argument	Type	Description
directions		ItineraryDirections	The created itinerary directions item
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-directions

CreateItineraryLinkCollectionLocationPayload

The fields available after creating an itinerary link

Field	Argument	Type	Description
link		ItineraryLinkCollectionLocation	The created itinerary link
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-link

CreateItineraryLinkItineraryPayload

The fields available after creating an itinerary link

Field	Argument	Type	Description
link		ItineraryLinkItinerary	The created itinerary link
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-link

CreateItineraryLocationPayload

The fields available after creating an itinerary location

Field	Argument	Type	Description
location		ItineraryLocation	The itinerary location that was created
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-location

CreateItineraryPayload

The fields available after creating an itinerary

Field	Argument	Type	Description
itinerary		Itinerary	The newly created itinerary

CreateItinerarySegmentPayload

The fields available after creating an itinerary segment

Field	Argument	Type	Description
segment		ItinerarySegment	The created itinerary segment
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary caused by the creation of the itinerary-segment

CreateProfilePayload

Response payload to Mutation.createProfile

Field	Argument	Type	Description
profile		Profile	The newly created profile

CreateUserAgreementPayload

The return fields available after creating a user agreement

Field	Argument	Type	Description
userAgreement		UserAgreement	The newly created user agreement

DeleteCollectionItemPayload

The fields available after deleting a collection

Field	Argument	Type	Description
id		ID	The ID of the collection, in the form of collection/XYZ

DeleteCollectionPayload

The available payload after performing a delete collection

Field	Argument	Type	Description
id		ID	The ID of the deleted collection

DeleteConnectedAppPayload

The available payload after performing a delete connected app

Field	Argument	Type	Description
id		ID	The ID of the deleted connected app

DeleteIconResourcePayload

The response after deleting an icon

Field	Argument	Type	Description
id		ID	The ID of the deleted icon

DeleteItineraryItemPayload

Deletes a itinerary item

Field	Argument	Type	Description
id		ID	The itinerary item identifier, in the form of item/XYZ
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

DeleteItineraryPayload

The result of deleting an itinerary

Field	Argument	Type	Description
id		ID	The ID of the deleted itinerary

DeleteProfilePayload

The result of deleting a profile

Field	Argument	Type	Description
id		ID	The ID of the profile itinerary

DenyProfileFollowPayload

Result of denying a follow request

Field	Argument	Type	Description
fromProfile		Profile!	The follower profile
toProfile		Profile!	The profile being followed
status		ProfileFollowStatus	The status of the follow request

DuplicateItineraryPayload

Response to Mutation.duplicateItinerary

Field	Argument	Type	Description
itinerary		Itinerary	The newly duplicated itinerary

Elevation

Elevation data

Field	Argument	Type	Description
gain		Float	The cumulative elevation gain
unit		DistanceUnit!	The unit of the output value
loss		Float	The cumulative elevation loss
unit		DistanceUnit!	The unit of the output value
min		Float	The minimum elevation
unit		DistanceUnit!	The unit of the output value
max		Float	The maximum elevation
unit		DistanceUnit!	The unit of the output value

EndMutationSessionPayload

The MutationSession that was ended

Field	Argument	Type	Description
mutationSession		MutationSession	The ended mutation session

FinalizeMediaUploadPayload

Result of finalizing a media upload

Field	Argument	Type	Description
status		MediaUploadStatus!	The status of this media upload
resource		MediaResource	The newly created media-resource

FollowProfilePayload

Result of creating a follow request

Field	Argument	Type	Description
fromProfile		Profile!	The follower profile
toProfile		Profile!	The profile being followed
status		ProfileFollowStatus	The status of the follow request

IconComposition

An icon with styles for use in an Itinerary

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
name		String!	A name for this IconComposition, should be unique across the itinerary
key		String!	A key for this IconComposition. Derived from the name
created		String!	The date when the IconComposition was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String!	The date when the IconComposition was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
resource		IconResourceEmbedded!	The Icon used by this IconComposition
iconFill		String	Optional fill color for the icon
shieldKey		String	Indicates which shield to use
shieldFill		String	Optional fill color for the shield
shieldStroke		String	Optional stroke color for the shield

IconCompositionConnection

Connection of IconCompositions

Field	Argument	Type	Description
edges		[IconCompositionEdge!]!	All the edges in this page of the connection
nodes		[IconComposition!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

IconCompositionEdge

Edge containing a IconComposition

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		IconComposition!	The item

IconResourceConnection

Connection of IconResources

Field	Argument	Type	Description
edges		[IconResourceEdge!]!	All the edges in this page of the connection
nodes		[IconResource!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

IconResourceEdge

Edge containing a IconResource

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		IconResource!	The item

IconResourceFailedToLoad

Represents an embedded IconResource that failed to load

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.

IconSilhouette

SVG path based IconResource

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile!	The profile associated with this icon
created		String	The date when the icon was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the icon was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
name		String!	The supplied name for this icon
key		String!	The key of the icon, unique across the profile
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
paths		[String!]!	SVG path data for this icon, eg: "M 100 .."
viewBox		String	Optional SVG viewBox for this icon

Isochrone

Isochrone for the given position with duration and vehicle

Field	Argument	Type	Description
duration		Float	The duration of the isochrone
unit		DurationUnit!	The unit of the output value
copyrights		[String!]!	Copyright details of the isochrone
mode		IsochroneMode!	The mode of transport of the isochrone
bounds		Bounds!	A bounding box around the isochrone
polygon		JSON!	The isochrone as a geojson polygon
simplify		GeoJsonSimplification	Optionally simplify the geojson data

Itinerary

An itinerary type is used to structure a series of items representing a travel itinerary

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile	Profile that owns this itinerary
created		String	The date when the itinerary was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the itinerary was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
published		String	The date when this itinerary was last published. Will be null on draft versions
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
lastPublished		String	The date when the itinerary was last published
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
lastDraft		String	The date when the draft version was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
defaultLocale		String	The default locale of this itinerary's content
item		ItineraryItem	Returns a single item from this itinerary by id
id		ID!	The unique identifier of the itinerary-item
autoRoute		ItineraryAutoRoute	If true, itinerary-directions will be created to automatically route between itinerary-locations
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
descendants		ItineraryItemConnection!	The descending items within this itinerary item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	The immediate associated children itinerary items
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
icons		IconCompositionConnection!	Icons that are used in this itinerary
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary item
elevation		Elevation!	Elevation data of the itinerary

ItineraryAutoRoute

Automatically generate ItineraryDirections that connect sibling ItineraryLocations

Field	Argument	Type	Description
defaultMode		RouteMode!	The default mode of transport to use for the generated ItineraryDirections

ItineraryCollection

An itinerary item representing a collection of other itinerary items

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary item
autoRoute		ItineraryAutoRoute	If true, itinerary-directions will be created to automatically route between descendant itinerary-locations

ItineraryDirections

An itinerary item representing directions from an origin location to the parent location. This item encapsulates modes of transport and routes.

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary-directions and it's descendants
origin		ItineraryDirectionsOriginDestination	The itinerary-location that is the starting point of the directions
destination		ItineraryDirectionsOriginDestination	The itinerary-location that is the ending point of the directions
route		Route!	The route details of this directions item
durations		[ItineraryDirectionsDurations!]!	The duration of this itinerary-directions
durationMin		Float	The minimum duration of this itinerary-directions
unit		DurationUnit!	The unit of the output value
durationMax		Float	The maximum duration of this itinerary-directions
unit		DurationUnit!	The unit of the output value
distance		Float	The estimated distance of this itinerary-directions
unit		DistanceUnit!	The unit of the output value
elevation		Elevation!	The elevation details of this itinerary-directions

ItineraryDirectionsConnection

Connection of ItineraryDirectionss

Field	Argument	Type	Description
edges		[ItineraryDirectionsEdge!]!	All the edges in this page of the connection
nodes		[ItineraryDirections!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ItineraryDirectionsDurations

An itinerary-directions duration value

Field	Argument	Type	Description
id		ID!	Unique identifier for this duration
duration		Float!	The duration value
unit		DurationUnit!	The unit of the output value
label		String	Label for the duration

ItineraryDirectionsEdge

Edge containing a ItineraryDirections

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		ItineraryDirections!	The item
direction		ItineraryDirectionsDirection!	Whether this itinerary-directions is inbound or outbound from the itinerary-location

ItineraryFailedToLoad

Represents an embedded Itinerary that failed to load

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.

ItineraryItemCascadedChanges

Changes to an itinerary caused by a mutation

Field	Argument	Type	Description
deletedIds		[ID!]!	Itinerary-items that were deleted due to the mutation
created		[ItineraryItem!]!	Itinerary-items that were created due to the mutation
updated		[ItineraryItem!]!	Itinerary-items that were updated due to the mutation

ItineraryItemConnection

Connection of ItineraryItems

Field	Argument	Type	Description
edges		[ItineraryItemEdge!]!	All the edges in this page of the connection
nodes		[ItineraryItem!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ItineraryItemEdge

Edge containing a ItineraryItem

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		ItineraryItem!	The item
edgePositionNumber		Float	A number corresponding to the item's position in the connection.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count ItineraryLocations that are optional. Other types of ItineraryItems will be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
directions		ItineraryDirectionsConnection!	List itinerary-directions connecting this node to other nodes in the connection
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
direction		ItineraryDirectionsDirection	Filter inbound or outbound itinerary-directions
limitImmediate		Boolean!	Limit to only directions under nodes that come immediately before or after this node.
skipOptional		Boolean!	Limit to only directions under nodes that are not optional locations. Will be applied before limitImmediate.

ItineraryLinkCollectionLocation

An itinerary item representing a link to a CollectionLocation

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	The bounds of the link in the itinerary
position		Position	The position of the link in the itinerary
resource		CollectionLocationEmbedded!	The CollectionLocation this item links to

ItineraryLinkItinerary

An itinerary item representing a link to another itinerary

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	The bounds of the link in the itinerary
position		Position	The position of the link in the itinerary
resource		ItineraryEmbedded!	The Itinerary this item links to

ItineraryLocation

An itinerary item representing a location with an associated place in the itinerary

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary-location and it's descendants
raw		Boolean!	If true, bounds will be the raw value on the location rather than a calculated value that takes descendants into account
place		Place!	The place details of this location
position		Position!	The position of the collection-location (derived from place if not overridden)
optional		Boolean!	Whether the location is an optional stop
contact		PlaceContact!	Contact information for the itinerary location
address		PlaceAddress!	Address information for the itinerary location
directions		ItineraryDirectionsConnection!	Retrieves itinerary-directions associated with this itinerary-location
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
direction		ItineraryDirectionsDirection	Filter inbound or outbound itinerary-directions
accuracy		ItineraryDirectionsAccuracy	How to determine if an itinerary-directions is related to the itinerary-location
restrict		ItineraryDirectionsRestrict	Restrict search to only portions of the itinerary. If set to null, directions from any part of the itinerary will be returned
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
icon		IconComposition	The IconComposition used by the this ItineraryLocation

ItinerarySearchConnection

Connection of ItinerarySearchs

Field	Argument	Type	Description
edges		[ItinerarySearchEdge!]!	All the edges in this page of the connection
nodes		[ItinerarySearchNode!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ItinerarySearchEdge

Edge containing a ItinerarySearch

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		ItinerarySearchNode!	The item

ItinerarySearchNode

A result from an itinerary search

Field	Argument	Type	Description
itinerary		Itinerary!	The full itinerary
id		ID!	The Globally Unique ID of the itinerary.
profile		Profile	Profile that owns this itinerary
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
created		String	The date when the itinerary was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the itinerary was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
published		String	The date when this itinerary was last published. Will be null on draft versions
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
lastPublished		String	The date when the itinerary was last published
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
lastDraft		String	The date when the draft version was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
preferredMedia		MediaContainer	The preferred MediaContainer to use
bounds		Bounds	Bounds for the itinerary item
totalLocations		Int!	Total number of ItineraryLocations inside this Itinerary
defaultLocale		String	The default locale of this itinerary's content
type		String	The type of itinerary
listed		Boolean	Whether this itinerary is publically listed
genres		[String!]	The genres of this Itinerary
externalId		ID	Identifier from an external source this itinerary is associated with
externalSource		ID	The source of this itinerary's externalId

ItinerarySegment

An itinerary item representing a segment in the itinerary

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary item
color		String	The color for the itinerary segment
contrastColor		String	The contrasting color for the itinerary segment

MediaContainer

A container for a MediaResource

Field	Argument	Type	Description
id		ID!	Unique identifier for this container
resource		MediaResourceEmbedded!	The MediaResource inside this container

MediaContainerConnection

Connection of MediaContainers

Field	Argument	Type	Description
edges		[MediaContainerEdge!]!	All the edges in this page of the connection
nodes		[MediaContainer!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

MediaContainerEdge

Edge containing a MediaContainer

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		MediaContainer!	The item

MediaImage

A MediaResource representing an image

Field	Argument	Type	Description
id		ID	Unique identifier for the media-resource
profile		Profile	The associated profile owner
provider		String!	The provider for the media
caption		String	Text caption for the media-resource
attribution		String	Text attribution for the source of the media-resource
copyright		String	Copyright details of the media-resource
hasContent		Boolean!	Will be true if the resource has a caption, attribution or copyright
altText		String	Alternative text for the media-resource
tags		[String!]!	A series of strings representing applied labels to the media
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
originalSize		[Int!]	The original width and height of the image
url		String	Provides the URL of the media
id		String	The specific source id to obtain the URL
bestFit		[Int!]	The dimensions as [width,height] to identify a preferred source for the media
source		MediaImageSource	Provides a specific source for the media, based often on different encoding or different sizing
id		String	The specific source id to obtain the URL
bestFit		[Int!]	The dimensions as [width,height] to identify a preferred source for the media
sources		[MediaImageSource!]!	A collection of sources for the media
exifIds		[ID!]!	Ids of all exif data in this media-image
exif		MediaImageExif	Look up one exif value in this media-image by id
id		ID!	Unique identifier of the exif value to look up

MediaImageExif

One exif datum on a media-image

Field	Argument	Type	Description
id		ID!	Unique identifier of this exif datum
value		JSON!	The exif value

MediaImageSource

An source for a media image

Field	Argument	Type	Description
id		String	A optional identifier for the source
type		String!	The content-type of the media source
url		String!	The URL to the media source
width		Int	The width of the media
height		Int	The height of the media

MediaResourceFailedToLoad

Represents an embedded MediaResource that failed to load

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.

MoveItineraryItemPayload

Moves the itinerary item

Field	Argument	Type	Description
item		ItineraryItem	The fields for the item
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by moving the itinerary-item

MutationSession

A session indicating a user has (un-enforced) exclusive access to a resource

Field	Argument	Type	Description
resourceId		ID!	The ID of the resource that is locked
created		String!	The date when the session was started
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
updated		String!	The date when the session was last extended
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
expires		String!	The date when the session will expire
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
forceTaken		Boolean!	Whether the session was forcibly taken
userGivenName		String	The given name of the user who owns the session
userFamilyName		String	The family name of the user who owns the session

PageInfo

Details regarding a page in a connnection

Field	Argument	Type	Description
hasPreviousPage		Boolean!	True if there is a page before this one
hasNextPage		Boolean!	True if there is a page after this one
startCursor		String	The cursor of the first edge in this page
endCursor		String	The cursor of the last edge in this page

Place

A defined location in the world

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
resolutionError		ResolutionError	If non-null, an error occured while resolving this place and only a subset of data will be accessible
title		String	Alias for Place.name
name		String	The name of the place
synopsis		String	A short summary
description		String	A longer description
tags		[String!]!	A collection of strings used to label this place
address		PlaceAddress!	The address of the place
position		Position!	The position of the place
bounds		Bounds	The bounding box around the place
hours		PlaceHours	The operating hours for this place, as encoded in OpenStreetMap hours specification
maki		String	The maki icon for this place
contributor		String	Source of the place data
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
attribution		[PlaceAttribution!]!	The required attribution required when using this place information
contact		PlaceContact!	Contact information supplied for this place
layers		[PlaceLayer!]!	Layers associated to this place
media ⚠️		[MediaContainer!]!	List of MediaContainers supplied with the place information, such as images of the places ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers supplied with the place information, such as images of the places
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
navigationUrl		String!	A url displaying how to navigate to this place
provider		PlaceNavigationUrlProvider!	The provider of the navigation url
towards		[PlaceTowards!]!	Calculate distance and bearing information towards the specified positions to this place
positions		[PositionInput!]!	Positions to calculate against
from		[PlaceFrom!]!	Calculate distance and bearing information from this place to the specified positions
positions		[PositionInput!]!	Positions to calculate against

PlaceAddress

The address data of a place

Field	Argument	Type	Description
addressLineOne		String
addressLineThree		String
addressLineTwo		String
administrativeGroup		String
area		String
country		String
countryCode		String
crossStreet		String
locality		String
postalCode		String
region		String
regionCode		String

PlaceAttribution

Describes the attribution requirements associated with the place.

Field	Argument	Type	Description
text		String	Text Attribution required for this place
link		String	A link required for this place
license		String	Specific licensing information for this place if known
pixel		String	The required tracking pixel
mediaResource		MediaResourceEmbedded	Any media to be used in attribution, such as watermarks

PlaceContact

Contact information for a Place

Field	Argument	Type	Description
websiteUrl		String	Contact website for this place
phoneNumber		String	Phone number for this place
emailAddress		String	Email address for this place
bookingUrl		String	Booking url for this place
facebookUrl		String	Facebook page for this place
twitterUrl		String	Twitter for this place
instagramUrl		String	Instagram for this place

PlaceFrom

Place bearing and distance information from position

Field	Argument	Type	Description
position		Position!	The position
bearing		Float!	The bearing angle from the position to the place
unit		AngleUnit!	The unit of the output value
distance		Float!	The distance from the position to the place
unit		DistanceUnit!	The unit of the output value
compass		CompassPoint!	Compass point from given position

PlaceHours

The opening hours for a place

Field	Argument	Type	Description
osmTag		String!	The opening hours formatted in the OpenStreetMap opening_hours tag format. See: https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification
weekStable		Boolean!	Whether or not the hours are the same each week.
status		PlaceHoursStatus!	Look up the open/closed status of the place for the current time or a given datetime.
datetime		String	The datetime to look up, if omitted or null, the current time will be used. Should be an ISO 8601 formatted string. If the timezone information is omitted, UTC will be assumed.
comment		String	Look up the place hours comment (if any) for the current time or a given datetime.
datetime		String	The datetime to look up, if omitted or null, the current time will be used. Should be an ISO 8601 formatted string. If the timezone information is omitted, UTC will be assumed.
intervals		PlaceHoursIntervalConnection!	Look up intervals where the opening hours status/comment for the place changes
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
from		String	Look up intervals starting from this datetime. If omitted or null, the current time will be used. Should be an ISO 8601 formatted string. If the timezone information is omitted, UTC will be assumed.
to		String	Look up intervals up to this datetime. If both the "to" and "offset" arguments are omitted or null, intervals will be calculated without limit. Cannot be used with the "offset" argument. Should be an ISO 8601 formatted string. If the timezone information is omitted, UTC will be assumed.
offset		DatetimeOffset	Alternative to the "to" argument, an offset from the "from" datetime. If the "from" argument is not specified, this specifies and offset from the current time. If both the "to" and "offset" arguments are omitted or null, intervals will be calculated without limit. Cannot be used with the "to" argument.
status		PlaceHoursStatus	Optionally filter to only intervals with the given status
forDays		[PlaceHoursForDay!]!	Look up the opening hours for a specific day. Days are calculated according to the local time of the place. Will return a maximum of 90 days.
days		[String!]	Look up hours for the specified days. Should be ISO 8601 formatted strings. Time information will be ignored. Cannot be used with the "from", "to" or "offset" arguments.
from		String	Look up hours starting from this day. If omitted or null, the current day (local time) will be used. Should be an ISO 8601 formatted string. Time information will be ignored.
to		String	Look up hours up to this day. If both the "to" and "offset" arguments are omitted or null, the next 7 days from the from day will be used. Cannot be used with the "offset" argument. Should be an ISO 8601 formatted string. Time information will be ignored.
offset		DatetimeOffset	Alternative to the "to" argument, an offset from the "from" datetime. If the "from" argument is not specified, this specifies and offset from the current time. If both the "to" and "offset" arguments are omitted or null, the next 7 days from the from day will be used. Cannot be used with the "to" argument.

PlaceHoursForDay

The opening hour for a place on a specific day

Field	Argument	Type	Description
date		String!	The date of the day. A full ISO 8061 formatted datetime corresponding to 12:00 am local time.
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
intervals		[PlaceHoursInterval!]!	The opening hour intervals for this day.
status		PlaceHoursStatus	Optionally filter to only intervals with the given status
publicHolidays		[String!]!	The name of any public holidays on this day.

PlaceHoursInterval

The opening hours for a place during the interval between two datetimes

Field	Argument	Type	Description
from		String!	The starting datetime of this interval
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
to		String	The ending datetime of this interval, will be null if there is no following interval and the status/comment will no longer change
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
status		PlaceHoursStatus!	The open/closed status of the place during this interval
comment		String	The place hours comment (if any) during this interval
publicHolidays		[PlaceHoursIntervalHoliday!]!	The holidays that occur during this interval Note: Will return holidays up to a maximum of one year from the "from" date

PlaceHoursIntervalConnection

Connection of PlaceHoursIntervals

Field	Argument	Type	Description
edges		[PlaceHoursIntervalEdge!]!	All the edges in this page of the connection
nodes		[PlaceHoursInterval!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection

PlaceHoursIntervalEdge

Edge containing a PlaceHoursInterval

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		PlaceHoursInterval!	The item

PlaceHoursIntervalHoliday

A holiday that occurs during an interval

Field	Argument	Type	Description
date		String!	The date of the holiday. A full ISO 8061 formatted datetime corresponding to 12:00 am local time.
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
name		String!	The name of the holiday.

PlaceLayer

A layer on a Place

Field	Argument	Type	Description
id		ID!	Unique identifier for this place layer
name		String	Name for this place layer

PlaceSearchConnection

Connection of PlaceSearchs

Field	Argument	Type	Description
edges		[PlaceSearchEdge!]!	All the edges in this page of the connection
nodes		[PlaceSearchNode!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection

PlaceSearchEdge

Edge containing a PlaceSearch

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		PlaceSearchNode!	The item
single		TextSearchResult!	The one line text search result
main		TextSearchResult!	The main line of the two line search result
secondary		TextSearchResult!	The secondary line of the two line search result

PlaceSearchNode

A result from a place search

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the place.
position		Position!	The position of the place
title		String	Alias for Place.name
name		String	The name of the place
synopsis		String	A short summary
description		String	A longer description
address		PlaceAddress!	The address of the place
maki		String	The maki icon for this place
layers		[PlaceLayer!]!	Layers associated to this place
contributor		String	Source of the place data

PlaceTowards

Place bearing and distance information towards position

Field	Argument	Type	Description
position		Position!	The position
bearing		Float!	The bearing angle from the place to the position
unit		AngleUnit!	The unit of the output value
distance		Float!	The distance from the place to the position
unit		DistanceUnit!	The unit of the output value
compass		CompassPoint!	Compass point towards given position

Position

A position on a map with a longitude and latitude

Field	Argument	Type	Description
lonLat		[Float!]!	The position in the form: [longitude, latitude]
latLon		[Float!]!	The position in the form: [latitude, longitude]
lat		Float!	The position's latitude
lon		Float!	The position's longitude
id		ID!	Identifier for the Position type useful for client-side caching
layers		[PlaceLayer!]!	PlaceLayers associated to this position
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
towards		[PositionTowards!]!	Calculate distance and bearing information towards the specified positions to this position
positions		[PositionInput!]!	Positions to calculate against
from		[PositionFrom!]!	Calculate distance and bearing information from this position to the specified positions
positions		[PositionInput!]!	Positions to calculate against

PositionFrom

Position bearing and distance information from position

Field	Argument	Type	Description
position		Position!	The position
bearing		Float!	The bearing angle from the position to the position
unit		AngleUnit!	The unit of the output value
distance		Float!	The distance from the position to the position
unit		DistanceUnit!	The unit of the output value
compass		CompassPoint!	Compass point from given position

PositionTowards

Position bearing and distance information towards position

Field	Argument	Type	Description
position		Position!	The position
bearing		Float!	The bearing angle from the position to the position
unit		AngleUnit!	The unit of the output value
distance		Float!	The distance from the position to the position
unit		DistanceUnit!	The unit of the output value
compass		CompassPoint!	Compass point towards given position

Profile

Profile

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
name		String!	The name of the profile
type		ProfileType!	The type of the profile
autoApproveFollows		Boolean!	Indicates if follows on this profile are automatically approved
handle		String	The (optional) unique handle of the profile
bio		String	A short biography
websiteUrl		String	The Website URL
avatar		MediaContainer	The avatar
followers		ProfileFollowConnection!	Profiles that follow this profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
status		ProfileFollowStatus	Filter by follow request status
handle		String	Filter by follower's handle
following		ProfileFollowConnection!	Profiles that this profile follows
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
status		ProfileFollowStatus	Filter by follow request status
handle		String	Filter by following profile's handle
billingDetails		BillingDetails	Fetch billing details associated with this profile
billingSubscriptions		BillingSubscriptionConnection!	Fetch billing subscriptions associated with a profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
connectedApps		ConnectedAppConnection!	Fetch connected-apps associated with this profile
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
deleted		Boolean	Return only deleted applications
expired		Boolean	Return only expired applications
type		ConnectedAppType	Filter by the app's type
authType		ConnectedAppAuthType	Filter by the app's authorization type
serviceKey		ConnectedAppServiceKey	Filter by the app's service key
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results

ProfileConnection

Connection of Profiles

Field	Argument	Type	Description
edges		[ProfileEdge!]!	All the edges in this page of the connection
nodes		[Profile!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ProfileEdge

Edge containing a Profile

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		Profile!	The item

ProfileFollowConnection

Connection of ProfileFollows

Field	Argument	Type	Description
edges		[ProfileFollowEdge!]!	All the edges in this page of the connection
nodes		[Profile!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

ProfileFollowEdge

Edge containing a ProfileFollow

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		Profile!	The item
status		ProfileFollowStatus!	The status of the follow request

PublishItineraryPayload

Response to Mutation.publishItinerary

Field	Argument	Type	Description
itinerary		Itinerary	The published itinerary

ResolutionError

Error which occurred while resolving an ID

Field	Argument	Type	Description
message		String!	Human readable error message

RevertItineraryPayload

Response to Mutation.revertItinerary

Field	Argument	Type	Description
itinerary		Itinerary	The reverted itinerary

Route

The representation of a route path taken

Field	Argument	Type	Description
segments		[RouteSegment!]!	The segments of this route
modes		[RouteMode!]!	The set of all RouteModes used by all the segments

RouteConnection

Connection of Routes

Field	Argument	Type	Description
edges		[RouteEdge!]!	All the edges in this page of the connection
nodes		[Route!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection

RouteEdge

Edge containing a Route

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		Route!	The item

RouteSegment

One segment of a Route

Field	Argument	Type	Description
id		ID!	WARNING: this ID is unstable, modifying the route might change the ID
mode		RouteMode!	The mode of transport to be taken. eg: car, walk, kayak, etc
positions		[Position!]	The way positions along this route
useRouteSearching		Boolean!	Whether this route was searched for
geoJson		JSON	The representation of this path as encoded as geojson FeatureCollection type
simplify		GeoJsonSimplification	Optionally simplify the geojson data
duration		Float	The estimated duration for this path
unit		DurationUnit!	The unit of the output value
distance		Float	The estimated distance for this path
unit		DistanceUnit!	The unit of the output value
elevation		Elevation!	The estimated elevation details of this route
polyline		String	The path representation as encoded as a polyline format
simplify		GeoJsonSimplification	Optionally simplify the path data before encoding

StartMediaUploadPayload

Result of starting a media upload

Field	Argument	Type	Description
token		String!	The upload token, required when finalising the upload
url		String!	The url to upload media to (via HTTP POST)
fields		JSON!	Data to pass with the upload

TextSearchResult

A text search result with a label and matches to highlight

Field	Argument	Type	Description
label		String!	Search result label
matches		[TextSearchResultMatch!]!	Text substring matches in the label text

TextSearchResultMatch

A details of a single result from a text search

Field	Argument	Type	Description
offset		Int!	Start of the match
length		Int!	Length of the match

UnfollowProfilePayload

Result of unfollowing a profile

Field	Argument	Type	Description
fromProfile		Profile!	The follower profile
toProfile		Profile!	The profile being followed
status		ProfileFollowStatus	The status of the follow request

UpdateBillingDetailsOutput

The output after updating the billing details

Field	Argument	Type	Description
billingDetails		BillingDetails!	The updated billing details

UpdateCollectionLocationPayload

The fields available after the collection location has been updated

Field	Argument	Type	Description
location		CollectionLocation	The collection location that was updated

UpdateCollectionPayload

The available fields after updating a collection

Field	Argument	Type	Description
collection		Collection	The updated collection

UpdateConnectedAppPayload

The available fields after updating a connected app

Field	Argument	Type	Description
connectedApp		ConnectedApp	The updated connected app

UpdateIconSilhouettePayload

The response after updating an icon

Field	Argument	Type	Description
icon		IconSilhouette	The updated icon

UpdateItineraryCollectionPayload

The fields available after updating the itinerary collection

Field	Argument	Type	Description
collection		ItineraryCollection	The itinerary collection that was created
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateItineraryDirectionsPayload

The fields available after updating the itinerary directions item

Field	Argument	Type	Description
directions		ItineraryDirections	The updated itinerary directions item
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateItineraryLinkCollectionLocationPayload

The fields available after updating the itinerary link

Field	Argument	Type	Description
link		ItineraryLinkCollectionLocation	The itinerary link that was created
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateItineraryLinkItineraryPayload

The fields available after updating the itinerary link

Field	Argument	Type	Description
link		ItineraryLinkItinerary	The itinerary link that was created
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateItineraryLocationPayload

The fields available after updating a location

Field	Argument	Type	Description
location		ItineraryLocation	The updated itinerary location
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateItineraryPayload

The available fields after updating a itinerary

Field	Argument	Type	Description
itinerary		Itinerary	The updated itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by updating the itinerary

UpdateItinerarySegmentPayload

The fields available after updating the itinerary segment

Field	Argument	Type	Description
segment		ItinerarySegment	The itinerary segment that was created
itinerary		Itinerary!	The modified itinerary
cascaded		ItineraryItemCascadedChanges!	Other changes to the itinerary that caused by deleting the itinerary-item

UpdateMediaResourcePayload

Response payload to Mutation.updateMediaResource

Field	Argument	Type	Description
resource		MediaResource!	The updated media-resource

UpdateProfilePayload

Response payload to Mutation.updateProfile

Field	Argument	Type	Description
profile		Profile	The updated profile

UserAgreement

An agreement made by a user

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile	Profile that associated with this agreement
date		String	The date when the agreement was made
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
type		String!	The type of agreement

UserAgreementConnection

Connection of UserAgreements

Field	Argument	Type	Description
edges		[UserAgreementEdge!]!	All the edges in this page of the connection
nodes		[UserAgreement!]!	Shortcut for edges[].node
pageInfo		PageInfo!	Details regarding the current page of the connnection
totalCount		Int!	The total number of items in the connection (in all pages)

UserAgreementEdge

Edge containing a UserAgreement

Field	Argument	Type	Description
cursor		String!	The cursor string pointing to this item
node		UserAgreement!	The item

Inputs

AttributeIdentifierInput

A selector for an attribute

Field		Type	Description
id		ID!	The attribute identifier
locale		String	The locale of the attribute

AttributeInput

Defines an attribute

Field		Type	Description
id		ID!	The attribute identifier
value		JSON!	The attribute value, can be any JSON-serialisable type
meta		JSON	Optional attribute metadata, can be any JSON-serialisable type
locale		String	Optional string representing the locale of the attribute value

BillingAddressInput

Fields for update billing address field

Field		Type	Description
addressLineOne		String!
addressLineTwo		String
locality		String!
region		String!
postalCode		String
countryCode		String!

BillingPriceInput

The billing price to use

Field		Type	Description
priceId		String!	The ID of a BillingPrice
quantity		Int	The quantity, defaults to 1

BoundsCircleInput

A bounding circle on a map defined by a center positions and a radius

Field		Type	Description
position		PositionInput!	The center position of the circle
radius		Float!	The radius of the bounding circle

BoundsInput

A bounding box on a map defined by two positions (opposite corners of the box)

Field		Type	Description
n		Float!	The north-most latitude of the bounding box
e		Float!	The east-most longitude of the bounding box
s		Float!	The south-most latitude of the bounding box
w		Float!	The west-most longitude of the bounding box

CollectionItemsSort

Determine how to sort CollectionItems when listing

Field		Type	Description
created		SortDirection	Sort by the created date
modified		SortDirection	Sort by the modified date
title		SortDirection	Sort by the collection-item title

CollectionsSort

Determine how to sort Collections when listing

Field		Type	Description
created		SortDirection	Sort by the created date
modified		SortDirection	Sort by the modified date
title		SortDirection	Sort by the collection title

CreateCollectionInput

Creates a collection

Field		Type	Description
discriminator		CollectionDiscriminator!	A label used to differentiate types of collections
title		String	Title of the collection
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]	A series of strings applied to label the collection
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attrs		[AttributeInput!]	Additional data defined on the collection
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new Collection

CreateCollectionLocationInput

The input to create a collection location

Field		Type	Description
title		String	Title for the new item
synopsis		String	A short summary text content for the new item
description		String	A longer description content for the new item
tags		[String!]	A collection of strings used to label the new item
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
sectionIds		[ID!]	One or more sections for this new item
externalId		ID	Identifier from an external source this new item is associated with
externalSource		ID	The source of this item's externalId
attrs		[AttributeInput!]	Additional data defined on this CollectionLocation
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new CollectionLocation
place		PlaceInput!	The associated place record for this location
position		PositionInput	Override for the place's position

CreateConnectedAppInput

Create a new ConnectedApp

Field		Type	Description
type		ConnectedAppType	The type of the connected-app
serviceKey		ConnectedAppServiceKey!	Identifies the service being connected to
scope		String	Any specific scope that has been granted to the 3rd party application
authType		ConnectedAppAuthType	The authenticated application method
privateConfiguration		JSON	Encrypted JSON
publicId		ID	3rd party ID or account ID

CreateIconCompositionInput

Create an IconComposition

Field		Type	Description
name		String!	A name for this IconComposition, should be unique across the itinerary
resourceId		ID!	ID to the Icon used by this IconComposition
iconFill		String	Optional fill color for the icon
shieldKey		String	Indicates which shield to use
shieldFill		String	Optional fill color for the shield
shieldStroke		String	Optional stroke color for the shield

CreateIconSilhouetteInput

Fields for a new IconSilhouette

Field		Type	Description
name		String!	The name of the icon, key will be generated from this value and so should be unique across the profile
paths		[String!]!	SVG path data for this icon, eg: "M 100 .."
viewBox		String	Optional SVG viewBox for this icon
attrs		[AttributeInput!]	Additional data defined on the icon

CreateItineraryCollectionInput

Creates an itinerary item collection type

Field		Type	Description
title		String	The title for the new itinerary-collection
synopsis		String	The synopsis for the new itinerary-collection
description		String	The description for the new itinerary-collection
tags		[String!]	The tags for the new itinerary-collection
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attrs		[AttributeInput!]	Additional data defined on the collection
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItineraryCollection
autoRoute		ItineraryAutoRouteInput	Enable auto routing, or set to null to disable
positionAtStart		ItineraryItemPositionAtStart	Creates the item positioned before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the item positioned after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Create the item positioned after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Create the item positioned before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Create the item at last position of the last itinerary-collection item

CreateItineraryDirectionsInput

The input fields to creating new itinerary directions items

Field		Type	Description
title		String	The title for the new itinerary-directions
synopsis		String	The synopsis for the new itinerary-directions
description		String	The description for the new itinerary-directions
tags		[String!]	The tags for the new itinerary-directions
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attrs		[AttributeInput!]	Additional data on the new itinerary
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItineraryDirections
originId		ID	The ID of the origin ItineraryLocation. Cannot be used with originPlace.
originPlace		PlaceInput	The origin place. Cannot be used with originId.
route		RouteInput!	The route of this item, must include at least one route segment
durations		[ItineraryDirectionsDurationsInput!]	The duration details of the new itinerary-directions
distance		Float	The distance of the new itinerary-directions
elevation		ElevationInput	The elevation details of the new itinerary-directions
positionAtStart		ItineraryItemPositionAtStart	Creates the itinerary-directions to be before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the itinerary-directions to be after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Creates the itinerary-directions after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Creates the itinerary-directions before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Creates the itinerary-directions at the last position of the last itinerary-collection item

CreateItineraryInput

Creates a itinerary

Field		Type	Description
defaultLocale		String	The default locale of this itinerary's content
title		String	The title for the new itinerary
synopsis		String	The synopsis for the new itinerary
description		String	The description for the new itinerary
tags		[String!]	The tags for the new itinerary
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attrs		[AttributeInput!]	Additional data on the new itinerary
autoRoute		ItineraryAutoRouteInput	Enable auto routing, or set to null to disable
elevation		ElevationInput	Elevation data of the new itinerary
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new Itinerary
icons		[CreateIconCompositionInput!]	The list of IconCompositions to add to the new Itinerary

CreateItineraryLinkCollectionLocationInput

Creates an itinerary link to a CollectionLocation

Field		Type	Description
title		String	The title for the new itinerary-link
synopsis		String	The synopsis for the new itinerary-link
description		String	The description for the new itinerary-link
tags		[String!]	The tags for the new itinerary-link
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
resourceId		ID!	The ID of the CollectionLocation to link to
attrs		[AttributeInput!]	Additional data defined on the link
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItineraryLink
positionAtStart		ItineraryItemPositionAtStart	Creates the item positioned before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the item positioned after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Create the item positioned after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Create the item positioned before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Create the item at last position of the last itinerary-collection item

CreateItineraryLinkItineraryInput

Creates an itinerary link to another itinerary

Field		Type	Description
title		String	The title for the new itinerary-link
synopsis		String	The synopsis for the new itinerary-link
description		String	The description for the new itinerary-link
tags		[String!]	The tags for the new itinerary-link
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
resourceId		ID!	The ID of the itinerary to link to
attrs		[AttributeInput!]	Additional data defined on the link
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItineraryLink
positionAtStart		ItineraryItemPositionAtStart	Creates the item positioned before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the item positioned after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Create the item positioned after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Create the item positioned before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Create the item at last position of the last itinerary-collection item

CreateItineraryLocationInput

The fields to create an itinerary location

Field		Type	Description
title		String	The title for the new itinerary-location
synopsis		String	The synopsis for the new itinerary-location
description		String	The description for the new itinerary-location
tags		[String!]	The tags for the new itinerary-location
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
attrs		[AttributeInput!]	Additional data defined on the collection
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItineraryLocation
position		PositionInput	The position of the itinerary-location
bounds		BoundsInput	The bounds of the itinerary-location
place		PlaceInput!	The place for this new itinerary-location
optional		Boolean	Whether this is an optional location on the itinerary
icon		ID	Set the optional icon, passed ID must exist in the Itinerary.icons
positionAtStart		ItineraryItemPositionAtStart	Creates the item positioned before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the item positioned after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Create the item positioned after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Create the item positioned before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Create the item at last position of the last itinerary-collection item

CreateItinerarySegmentInput

Creates an itinerary item segment type

Field		Type	Description
title		String	The title for the new itinerary-segment
synopsis		String	The synopsis for the new itinerary-segment
description		String	The description for the new itinerary-segment
tags		[String!]	The tags for the new itinerary-segment
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
color		String	The color for the itinerary segment
contrastColor		String	The contrasting color for the itinerary segment
attrs		[AttributeInput!]	Additional data defined on the segment
media		[CreateMediaContainerInput!]	The list of MediaContainers to add to the new ItinerarySegment
positionAtStart		ItineraryItemPositionAtStart	Creates the item positioned before all its siblings
positionAtEnd		ItineraryItemPositionAtEnd	Creates the item positioned after all its siblings
positionAfterSibling		ItineraryItemPositionAfterSibling	Create the item positioned after the given sibling
positionBeforeSibling		ItineraryItemPositionBeforeSibling	Create the item positioned before the given sibling
positionOnLastCollection		ItineraryItemPositionOnLastCollection	Create the item at last position of the last itinerary-collection item

CreateMediaContainerInput

Create a MediaContainer in a MediaContainer list

Field		Type	Description
resourceId		String!	ID to a MediaResource to contain
positionBefore		MediaContainerPositionBefore	Add the MediaContainer before another container in the list
positionAfter		MediaContainerPositionAfter	Add the MediaContainer after another container in the list
positionAtStart		MediaContainerPositionAtStart	Add the MediaContainer at the start of the list
positionAtEnd		MediaContainerPositionAtEnd	Add the MediaContainer at the end of the list

CreateProfileInput

Input object to Mutation.createProfile

Field		Type	Description
type		ProfileType!	The type of profile
name		String!	The name of the profile
bio		String	A short biography
websiteUrl		String	The website url
autoApproveFollows		Boolean	If follow requests should be automatically approved for this profile
avatar		MediaContainerInput	The avatar image
attrs		[AttributeInput!]	Additional data defined on the profile

CreateUserAgreementInput

Input object to Mutation.createUserAgreement

Field		Type	Description
type		String!	The type of agreement

DatetimeOffset

An offset in date and/or time represented as integer differences for each datetime field

Field		Type	Description
years		Int	Positive or negative difference for years
months		Int	Positive or negative difference for months
weeks		Int	Positive or negative difference for weeks
days		Int	Positive or negative difference for days
hours		Int	Positive or negative difference for hours
minutes		Int	Positive or negative difference for minutes
seconds		Int	Positive or negative difference for seconds

ElevationInput

Input elevation data

Field		Type	Description
gain		Float	The cumulative elevation gain
loss		Float	The cumulative elevation loss
min		Float	The minimum elevation
max		Float	The maximum elevation

FinalizeMediaUploadInput

Uploads a media resource

Field		Type	Description
tags		[String!]	List of labels to apply to the new media-resource
attribution		String	Text attribution for the source of the new media-resource
caption		String	Text caption for the new media-resource
copyright		String	Copyright details of the new media-resource
attrs		[AttributeInput!]	Additional data to define on the new media-resource

GeoJsonSimplification

Different GeoJSON simplification algorithms

Field		Type	Description
ramerDouglasPeucker		GeoJsonSimplificationRamerDouglasPeucker!	The Ramer-Douglas-Peucker algorithm

GeoJsonSimplificationRamerDouglasPeucker

The Ramer-Douglas-Peucker algorithm

Field		Type	Description
tolerance		Float	The amount of application applied, higher values result in more simplification
highQuality		Boolean	Modify the algorithm to be slower by produce higher quality results

ItinerariesSort

Determine how to sort Itineraries when listing

Field		Type	Description
created		SortDirection	Sort by the created date
modified		SortDirection	Sort by the modified date
title		SortDirection	Sort by the itinerary title

ItineraryAutoRouteInput

Automatically generate ItineraryDirections that connect sibling ItineraryLocations

Field		Type	Description
defaultMode		RouteMode	The default mode of transport to use for the generated ItineraryDirections, if excluded defaults to Car

ItineraryDirectionsDurationsInput

Input an ItineraryDirections duration value

Field		Type	Description
duration		Float!	The duration value
label		String	Label for the duration

ItineraryItemPositionAfterSibling

Positions the item after a sibling

Field		Type	Description
siblingId		ID	The sibling itinerary item identifier, in the form of item/XYZ

ItineraryItemPositionAtEnd

Positions the item at the end position of its siblings

Field		Type	Description
parentId		ID	The parent itinerary item identifier, in the form of item/XYZ

ItineraryItemPositionAtStart

Positions the item at the start position of its siblings

Field		Type	Description
parentId		ID	The parent itinerary item identifier, in the form of item/XYZ

ItineraryItemPositionBeforeSibling

Positions the item before a sibling

Field		Type	Description
siblingId		ID	The sibling itinerary item identifier, in the form of item/XYZ

ItineraryItemPositionOnLastCollection

Positions the itinerary item to the last position of the last itinerary collection item

Field		Type	Description
searchUnder		ID	The itinerary item identifier to limit descendent searching withing

MediaContainerInput

Set a singular MediaContainer

Field		Type	Description
resourceId		String!	ID to a MediaResource to contain

MediaContainerPositionAfter

Positions the MediaContainer after a sibling MediaContainer

Field		Type	Description
id		ID	The sibling MediaContainer identifier, if null it means the top of the list (ie. before the first sibling)

MediaContainerPositionAtEnd

Positions the MediaContainer at the end of the list

Field		Type	Description
_		Int	Ignored, required by GraphQL which does not allow empty input objects

MediaContainerPositionAtStart

Positions the MediaContainer at the start of the list

Field		Type	Description
_		Int	Ignored, required by GraphQL which does not allow empty input objects

MediaContainerPositionBefore

Positions the MediaContainer before a sibling MediaContainer

Field		Type	Description
id		ID	The sibling MediaContainer identifier, if null it means the bottom of the list (ie. after the last sibling)

MoveMediaContainerInput

Move a MediaContainer within a list, exactly one of the position arguments is required.

Field		Type	Description
id		String!	ID to the Container to update
positionBefore		MediaContainerPositionBefore	Move the MediaContainer before another container in the list
positionAfter		MediaContainerPositionAfter	Move the MediaContainer after another container in the list
positionAtStart		MediaContainerPositionAtStart	Move the MediaContainer at the start of the list
positionAtEnd		MediaContainerPositionAtEnd	Move the MediaContainer at the end of the list

PlaceInput

Create a new place or refer to an existing place

Field		Type	Description
id		ID	Unique place identifier
position		PositionInput!	The position of the place

PositionInput

A position on a map with a longitude and latitude

Field		Type	Description
lon		Float!	The longitude
lat		Float!	The latitude

RouteInput

Create a Route

Field		Type	Description
segments		[RouteSegmentInput!]!	The segments of this route

RouteSegmentInput

Create a RouteSegment

Field		Type	Description
mode		RouteMode	The mode of transport to be taken on this segment, defaults to Car
positions		[PositionInput!]	The way positions along this route
useRouteSearching		Boolean	Whether to plan out a route using the positions. Defaults to true if the mode is searchable and otherwise will be set to false
distance		Float	The distance for this route segment
duration		Float	The duration for this route segment

UpdateBillingDetailsInput

The fields to change when updating the billing details

Field		Type	Description
emailAddress		String!	The email address
givenName		String!	The given name
familyName		String!	The family name
organization		String	The optional organization name
address		BillingAddressInput!	The billing address

UpdateCollectionInput

Updates a collection

Field		Type	Description
title		String	The title for the collection
synopsis		String	The synopsis for the collection
description		String	The description for the collection
tags		[String!]	The tags for the collection
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
upsertAttrs		[AttributeInput!]	Insert or update attributes to the collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers

UpdateCollectionLocationInput

The fields for the collection location to update

Field		Type	Description
title		String	Title for this item
synopsis		String	A longer description content for this item
description		String	A longer description content for this item
tags		[String!]	A collection of strings used to label this item
readMoreUrl		String	Shortcut for setting the read-more attribute
websiteUrl		String	Shortcut for setting the website-url attribute
sectionIds		[ID!]	One or more sections for this item
externalId		ID	Identifier from an external source this item is associated with
externalSource		ID	The source of this item's externalId
place		PlaceInput	The associated place information for this item
position		PositionInput	Override for the place's position
upsertAttrs		[AttributeInput!]	Insert or update attributes to the collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers

UpdateConnectedAppInput

Updates a connected app

Field		Type	Description
authType		ConnectedAppAuthType	The type of the connected-app
scope		String	Any specific scope that has been granted to the 3rd party application
publicId		ID	3rd party ID or account ID
privateConfiguration		String	Encrypted JSON

UpdateIconCompositionInput

Update an IconComposition

Field		Type	Description
id		String!	ID of the IconComposition to update
name		String	Change the name
resourceId		ID	Change the Icon used by this IconComposition
iconFill		String	Change the fill color for the icon, set to null to remove the fill
shieldKey		String	Change which shield to use for the icon, set to null to clear the shieldFill and shieldStroke as well
shieldFill		String	Change the fill color for the shield, set to null to remove the fill
shieldStroke		String	Change the stroke color for the shield, set to null to remove the stroke

UpdateIconSilhouetteInput

Fields for updating an IconSilhouette

Field		Type	Description
name		String	Change the name of this icon
paths		[String!]	SVG path data for this icon, eg: "M 100 .."
viewBox		String	Optional SVG viewBox for this icon
upsertAttrs		[AttributeInput!]	Insert or update attributes to the icon
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the icon

UpdateItineraryCollectionInput

The intinerary collection fields to update

Field		Type	Description
title		String	The title for the itinerary-collection
synopsis		String	The synopsis for the itinerary-collection
description		String	The description for the itinerary-collection
tags		[String!]	The tags for the itinerary-collection
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
upsertAttrs		[AttributeInput!]	Insert or update attributes to the itinerary-collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the itinerary-collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers
autoRoute		ItineraryAutoRouteInput	Enable auto routing, or set to null to disable
autoRouteRemoveExisting		Boolean	Remove any routes that were created with auto routing

UpdateItineraryDirectionsInput

The input fields to update the itinerary directions

Field		Type	Description
title		String	The title for the itinerary directions
synopsis		String	The synopsis for the itinerary-directions
description		String	The description for the itinerary-directions
tags		[String!]	The tags for the itinerary-directions
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
upsertAttrs		[AttributeInput!]	Insert or update attributes to the collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers
originId		ID	The ID of the origin ItineraryLocation. Set to null to unset the origin. Cannot be used with originPlace.
originPlace		PlaceInput	The origin place. Set to null to unset the origin. Cannot be used with originId.
route		RouteInput	The route of this item, must include at least one route segment
distance		Float	The distance of the itinerary-directions
durations		[ItineraryDirectionsDurationsInput!]	The duration details of the new itinerary-directions
elevation		ElevationInput	The elevation details of the new itinerary-directions

UpdateItineraryInput

Updates a itinerary

Field		Type	Description
defaultLocale		String	The default locale of this itinerary's content
title		String	The title for the itinerary
synopsis		String	The synopsis for the itinerary
description		String	The description for the itinerary
tags		[String!]	The tags for the itinerary
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
upsertAttrs		[AttributeInput!]	Insert or update attributes to the collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers
createIcons		[CreateIconCompositionInput!]	Add new IconCompositions to the itinerary
updateIcons		[UpdateIconCompositionInput!]	Update IconCompositions in the itinerary
deleteIcons		[ID!]	Delete one or move IconCompositions
autoRoute		ItineraryAutoRouteInput	Enable auto routing, or set to null to disable
autoRouteRemoveExisting		Boolean	Remove any routes that were created with auto routing
elevation		ElevationInput	Elevation data of the new itinerary

UpdateItineraryLinkCollectionLocationInput

The intinerary link fields to update

Field		Type	Description
title		String	The title for the itinerary-link
synopsis		String	The synopsis for the itinerary-link
description		String	The description for the itinerary-link
tags		[String!]	The tags for the itinerary-link
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
resourceId		ID!	The ID of the itinerary to link to
upsertAttrs		[AttributeInput!]	Insert or update attributes to the itinerary-link
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the itinerary-link
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers

UpdateItineraryLinkItineraryInput

The intinerary link fields to update

Field		Type	Description
title		String	The title for the itinerary-link
synopsis		String	The synopsis for the itinerary-link
description		String	The description for the itinerary-link
tags		[String!]	The tags for the itinerary-link
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
resourceId		ID!	The ID of the itinerary to link to
upsertAttrs		[AttributeInput!]	Insert or update attributes to the itinerary-link
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the itinerary-link
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers

UpdateItineraryLocationInput

The fields to update on an itinerary location

Field		Type	Description
title		String	The title for the itinerary-location
synopsis		String	The synopsis for the itinerary-location
description		String	The description for the itinerary-location
tags		[String!]	The tags for the itinerary-location
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
upsertAttrs		[AttributeInput!]	Insert or update attributes to the itinerary-collection
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the itinerary-collection
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers
position		PositionInput	The place for this itinerary-location
bounds		BoundsInput	The bounds of the itinerary-location
place		PlaceInput	The place for this itinerary-location
optional		Boolean	Whether the location specified is optional on the itinerary
icon		ID	Set or remove the optional icon, passed ID must exist in the Itinerary.icons

UpdateItinerarySegmentInput

The intinerary segment fields to update

Field		Type	Description
title		String	The title for the itinerary-segment
synopsis		String	The synopsis for the itinerary-segment
description		String	The description for the itinerary-segment
tags		[String!]	The tags for the itinerary-segment
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
color		String	The color for the itinerary-segment
contrastColor		String	The contrast color for the itinerary-segment
upsertAttrs		[AttributeInput!]	Insert or update attributes to the itinerary-segment
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the itinerary-segment
createMedia		[CreateMediaContainerInput!]	Add multiple Media with MediaResources
moveMedia		[MoveMediaContainerInput!]	Move one or move MediaContainers
updateMedia		[UpdateMediaContainerInput!]	Update one or move MediaContainers
deleteMedia		[ID!]	Delete one or move MediaContainers

UpdateMediaContainerInput

Update a MediaContainer in a MediaContainer list

Field		Type	Description
id		String!	ID to the MediaContainer to update
resourceId		String	ID to a MediaResource

UpdateMediaResourceInput

Updates a media resource

Field		Type	Description
tags		[String!]	List of labels to apply to the media-resource
attribution		String	Text attribution for the source of the media-resource
caption		String	Text caption for the media-resource
copyright		String	Copyright details of the media-resource
upsertAttrs		[AttributeInput!]	Insert or update attributes to the media-resource
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the media-resource

UpdateProfileInput

Input object to Mutation.updateProfile

Field		Type	Description
type		ProfileType	The type of profile
name		String	The name of the profile
bio		String	A short biography
websiteUrl		String	The website url
autoApproveFollows		Boolean	If follow requests should be automatically approved for this profile
avatar		MediaContainerInput	The avatar image
upsertAttrs		[AttributeInput!]	Insert or update attributes to the profile
deleteAttrs		[AttributeIdentifierInput!]	Delete attributes to the profile

Enums

AngleUnit

Angle unit

Value	Description
Degrees
Radians

BeginMutationSessionResult

The result of attempting to begin a mutation session

Value	Description
Begun
Extended
Denied

BillingPriceRecurringInterval

The interval type

Value	Description
Year
Month
Week
Day

BillingSubscriptionStatus

The status of a BillingSubscription

Value	Description
Active
Inactive
Expired
Cancelled

CollectionDiscriminator

All possible collection discriminators

Value	Description
Collection
Locale

CompassPoint

Points on the compass rose

Value	Description
N
NE
E
SE
S
SW
W
NW

ConnectedAppAuthType

Possible auth types for a ConnectedApp

Value	Description
Tokens
Oauth
Credentials

ConnectedAppServiceKey

The key of the service for a ConnectedApp

Value	Description
AustralianTourismDataWarehouse
AustralianTourismDataWarehouseContributor
CrowdriffApi
ShopifyApi
GoogleAnalytics4
AlpacaLegacy
StravaApi

ConnectedAppType

Possible types of ConnectedApp

Value	Description
Configuration
Credentials
Api

DistanceUnit

Distance unit

Value	Description
Kilometers
Feet
Miles
Meters

DurationUnit

Duration unit

Value	Description
Seconds
Minutes
Hours

IsochroneMode

Mode of transport for an isochrone

Value	Description
Car
Bike
Foot

ItineraryDirectionsAccuracy

The method to determine if an ItineraryDirections is related to an ItineraryLocation

Value	Description
Location	Consider itinerary-directions related if the itinerary-location matches
Place	Consider itinerary-directions related if the place inside the itinerary-location matches

ItineraryDirectionsDirection

Whether or not an ItineraryDirections is inbound or outbound relative to an ItineraryLocation

Value	Description
Inbound
Outbound

ItineraryDirectionsRestrict

Restricts search for directions to a portion of an Itinerary

Value	Description
ParentDescendants	Restrict results to include directions that are descendants of the parent item

ItineraryItemType

Possible types of ItineraryItem

Value	Description
ItineraryCollection
ItineraryLocation
ItineraryDirections
ItinerarySegment
ItineraryLink

MediaUploadStatus

The status of a Media upload process

Value	Description
AwaitingUpload
Processing
Complete
ProcessingFailed

PlaceHoursStatus

Whether a place is open/closed or if the status is unknown

Value	Description
Open
Closed
Unknown

PlaceNavigationUrlProvider

Navigation service provider

Value	Description
Google
Apple

PlaceSearchSource

Where to search for place information

Value	Description
OpenStreetMap
Facebook
OpenAddresses
Geonames
Yelp
AustralianTourismDataWarehouse
Zomato
TripAdvisor
WhosOnFirst

ProfileFollowStatus

Profile follow status

Value	Description
Pending
Approved
Denied

ProfileType

Profile type

Value	Description
Individual
Organization

RouteMode

Modes of transport

Value	Description
Bike
Bus
Camel
Car
Cycling
ElectricCar
ElectricMotorbike
Foot
FourWheelDriving
Hike
Hitchhiking
Horse
HorseAndCart
InlineSkate
Minibus
Motorcycle
MountainBike
NordicWalking
Rickshaw
Run
Scooter
Snowshoe
TaxiOrRideshare
TrailRun
Trekking
WalkOrRide
Wheelchair
Abseiling
AdventureBike
AerialLift
AlpineSki
BackcountrySki
Barge
Boat
CableCar
Canoe
Caving
Chairlift
CrossCountrySky
Cruise
Dirtbike
Dive
DogSled
Ferry
Funicular
Geocaching
Glider
Golfcar
Gondola
HandGliding
Handcycle
Helicopter
HotAirBaloon
IceSkate
JetBoat
Jetski
Kayak
Kitesurf
LightAircraft
LightRail
Monorail
Mountaineering
NordicSki
Orienteering
Plane
Quadbike
RockClimbing
Row
Rowboat
Sail
Skateboarding
Skydive
Snorkel
Snowboard
StandUpPaddleBoard
Surf
Swim
Train
Transit
Tubing
WaterSki
WaterTaxi
WhiteWaterRafting
Windsurf
ZipLine

RouteSearchableMode

Subset of RouteModes supporting route search

Value	Description
Bike
Bus
Camel
Car
Cycling
ElectricCar
ElectricMotorbike
Foot
FourWheelDriving
Hike
Hitchhiking
Horse
HorseAndCart
InlineSkate
Minibus
Motorcycle
MountainBike
NordicWalking
Rickshaw
Run
Scooter
Snowshoe
TaxiOrRideshare
TrailRun
Trekking
WalkOrRide
Wheelchair

SortDirection

Determines which order a specific field will be ordered in

Value	Description
Asc	Sort in ascending order
Desc	Sort in descending order

Scalars

Boolean

The Boolean scalar type represents true or false.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

The JSON scalar type represents JSON values as specified by ECMA-404.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Interfaces

CollectionItem

A collection item contains data about a single entity and is assigned within a collection

Field	Argument	Type	Description
id		ID!	The unique identifier, taking the shape of item/XYZ
profile		Profile!	The associated profile owner
created		String	The date when the collection-item was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the collection-item was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
sectionIds		[ID!]!	One or more sections this item belongs to
externalId		ID	Identifier from an external source this item is associated with
externalSource		ID	The source of the item's externalId
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results

IconResource

An icon for use in the UI or Map

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.
profile		Profile!	The profile associated with this icon
created		String	The date when the icon was created
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
modified		String	The date when the icon was last modified
format		String	Output the date according to the given format specifier string. Cannot be used with "relativeTo".
relativeTo		String	Output the difference between this date and the given date. Set to null to output the difference between this date and the current date. Should be an ISO 8601 formatted string.
timeZone		String	Set the time zone of the date
locale		String	Set the output locale
name		String!	The supplied name for this icon
key		String!	The key of the icon, unique across the profile
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results

ItineraryItem

An item in an itinerary as part of the tree

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	Bounds for the itinerary item

ItineraryLink

An itinerary item representing a link to another resource

Field	Argument	Type	Description
id		ID!	Unique identifier for the itinerary-item
siblingPositionNumber		Float	A number corresponding to the item's position compared to it's siblings.
type		ItineraryItemType	Only count items of the given type
skipOptional		Boolean!	Don't count locations that are optional. Non-locations will always be counted.
skipOmitList		Boolean!	Don't count items that have the omit-list attrubute set to true
title		String	The supplied title
synopsis		String	A short text summary
description		String	A longer text description
tags		[String!]!	A series of strings applied to label this item
media ⚠️		[MediaContainer!]!	List of MediaContainers containing images or other media ⚠️ DEPRECATED use mediaContainers instead
limit		Int!	The number of media to return
mediaContainers		MediaContainerConnection!	List of MediaContainers containing images or other media
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
preferredMedia		MediaContainer	The preferred MediaContainer to use
readMoreUrl		String	Alias for the read-more attribute
websiteUrl		String	Alias for the website-url attribute
itinerary		Itinerary!	The itinerary this item belongs to
before		ItineraryItem	The sibling item that comes before this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
after		ItineraryItem	The sibling item that comes after this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
parent		ItineraryItem	The parent item of this item
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
ancestors		ItineraryItemConnection!	All ancestors of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
descendants		ItineraryItemConnection!	All the descendants of the itinerary-item in depth-first-search order
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
depthMax		Int	Optionally limit the maximum depth of the traversal
depthMin		Int	Optionally limit the minimum depth of the traversal
children		ItineraryItemConnection!	All the direct children of the itinerary-item
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
type		ItineraryItemType	Optionally filter by item type eg: "ItineraryCollection"
parentType		ItineraryItemType	Optionally filter by type of the item's parent eg: "ItineraryCollection"
placeIds		[ID!]	Optionally look for items that contain any of the given places Only looks at the place field on ItineraryLocations
segmentIds		[ID!]	Optionally look for items that belong to all of the given segments
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results
bounds		Bounds	The bounds of the link in the itinerary
position		Position	The position of the link in the itinerary

MediaResource

Representing media such as images/photos as well as other types such as video or audio

Field	Argument	Type	Description
id		ID	Unique identifier for the media-resource
profile		Profile	The associated profile owner
provider		String!	The provider for the media
caption		String	Text caption for the media-resource
attribution		String	Text attribution for the source of the media-resource
copyright		String	Copyright details of the media-resource
hasContent		Boolean!	Will be true if the resource has a caption, attribution or copyright
altText		String	Alternative text for the media-resource
tags		[String!]!	A series of strings representing applied labels to the media
attr		Attribute	Arbitrary JSON value stored on this resource, keyed by an id
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrValue		JSON	Shortcut for the attr.value, returns null if the attribute doesn't exist
id		ID!	The id of the attribute to select
locale		String	The locale of the attribute to select
attrs		AttributeConnection!	Query multiple attributes optionally filtering by id and/or locale
first		Int!	Returns up to the first n elements in the list
after		String	Returns elements that come after the given cursor
id		ID	The id of the attribute to select
locale		String	The locale of the attribute to select. This will only apply to attributes with a locale, attributes that don't will not be excluded.
includeNoLocale		Boolean	Whether or not to include attributes without locales in the results

Node

An object with a Globally Unique ID

Field	Argument	Type	Description
id		ID!	The Globally Unique ID of the object.