GraphQL reference

This page is generated from api/schema.graphql, the schema the API checks in. To change it, change the schema in api/app/graphql and regenerate the dump with bin/rails graphql:schema:dump (see GraphQL).

Query

Field	Type	Description
audience	Audience	The audience this endpoint is scoped to.
audiences	[Audience!]!	Fetches all audiences, or only the scoped audience.
locales	[Locale!]!	Fetches all locales in the audience.
me	User	Fetches current user
node id: ID!	Node	Fetches an object given its ID.
nodes ids: [ID!]!	[Node]	Fetches a list of objects given a list of IDs.
people	[Person!]!	Fetches all people in the audience.
venues	[Venue!]!	Fetches all venues in the audience.

Mutation

Field	Type	Description
createLocaleCreate input: LocaleCreateInput!	LocaleCreatePayload	Creates a new locale
createPersonCreate input: PersonCreateInput!	PersonCreatePayload	Creates a new Persona (A Promoter, Persona, Organization)
createVenueCreate input: VenueCreateInput!	VenueCreatePayload	Creates a new Venue (A location that holds events)
updateAudience input: AudienceUpdateInput!	AudienceUpdatePayload	Renames an audience or changes its subdomain. Subdomains change only from /v1/tenants/graphql.
updateAudienceTheme input: AudienceThemeUpdateInput!	AudienceThemeUpdatePayload	Replaces an audience’s theme: its design system preset, tagline and color overrides.
updatePersonUpdate input: PersonUpdateInput!	PersonUpdatePayload	Updates a person by id

Objects

Audience

Object

Field	Type	Description
domains	[AudienceDomain!]!
facebookApps	[FacebookApp!]!	The audience’s Facebook apps, one per environment.
id	ID!
locales	[Locale!]!
members	[AudienceMember!]!	People who have signed in on the audience’s console. Admins only; empty for everyone else.
name	String!
people	[Person!]!
subdomain	String!
theme	AudienceTheme!	The audience’s look: preset, tagline and colors.
venues	[Venue!]!

AudienceDomain

Object

A domain connected to an audience. Its admin console is served at admin.<domain> once it’s verified.

Field	Type	Description
adminHost	String!	Where the audience admin console is served: admin.<domain>.
audienceId	ID!
certificateStatus	String	Heroku’s certificate status for the admin host.
checkedAt	ISO8601DateTime	When DNS was last checked.
createdAt	ISO8601DateTime!
dnsName	String!
dnsTarget	String	The CNAME target for the admin host, once it has been added to Heroku.
id	ID!
txtRecordName	String!	The TXT record that proves control of the domain.
txtRecordValue	String!	The value of that TXT record.
updatedAt	ISO8601DateTime!
verifiedAt	ISO8601DateTime	When the TXT record was found.

AudienceMember

Object

Someone who has signed in on an audience’s console.

Field	Type	Description
id	ID!	The ID of the membership.
isAdmin	Boolean!	Whether they manage the audience.
joinedAt	ISO8601DateTime!	When they first signed in there.
name	String	Their name, from Facebook.
userId	ID!	The ID of the user.

AudienceTheme

Object

An audience’s customization of the AudienceKit design system.

Field	Type	Description
dark	[ThemeToken!]!	Token overrides for dark mode.
light	[ThemeToken!]!	Token overrides for light mode.
preset	String!	Design system preset, e.g. default or hot_mess.
tagline	String	One line about the audience, in its own voice.

Event

Object

Field	Type	Description
coverPhotoId	ID
endAt	ISO8601DateTime
eventTemplatesId	ID
facebookId	Int!
id	ID!
isFeatured	Boolean!
name	String
nameOverride	String
order	Int!
startAt	ISO8601DateTime

FacebookApp

Object

A Facebook app the audience’s people sign in with. Its secret is never returned.

Field	Type	Description
environment	String!	production, staging or development.
facebookAppId	String!	The Facebook app ID.
facebookLoginConfigId	String	The Facebook Login for Business configuration ID Business-type apps sign people in with.
id	ID!	The ID of the connection.
name	String!	A label, e.g. “Hot Mess (staging)”.

Locale

Object · implements HasCover, HasTimestamps

Field	Type	Description
beaconMajor	Int
cityNames	String
coverImageUrl	PhotoURL
createdAt	ISO8601DateTime!
envelope	GeoJSON
events	[Event!]!
id	ID!
label	String
location	Location
name	String
people	[Person!]!
timezoneZuluDelta	Int
updatedAt	ISO8601DateTime!
venues	[Venue!]!

Location

Object · implements HasCover, HasPhoto, HasTimestamps

Field	Type	Description
coverImageUrl	PhotoURL
createdAt	ISO8601DateTime!
envelope	Geography
googleLocation	JSON!
googlePlaceId	String!
id	ID!
photoUrl	PhotoURL
point	Geography
updatedAt	ISO8601DateTime!

Page

Object · implements HasCover, HasPhoto, HasTimestamps

Field	Type	Description
coverImageUrl	PhotoURL
createdAt	ISO8601DateTime!
facebookId	Int!
facets	String
id	ID!
name	String!
photoUrl	PhotoURL
updatedAt	ISO8601DateTime!

Person

Object

Field	Type	Description
audience	Audience!
global	Boolean!
id	ID!
likeRequired	Boolean!
order	Int!
page	Page!

Photo

Object · implements HasPhoto

Field	Type	Description
cdnUrl	String!
contentHash	Binary!
id	ID!
mime	String!
photoUrl	PhotoURL
sourceUrl	PhotoURL!

ThemeToken

Object

One design system color token and its value.

Field	Type	Description
name	String!	Token name, e.g. accent or spectrum-1.
value	String!	Hex color, e.g. #b8236f.

User

Object

Field	Type	Description
audiences isAdmin: Boolean	[Audience!]!
createdAt	ISO8601DateTime!
culture	String
currentVenue	Venue
emailAddress	String
facebookId	Int!
facebookScopes	String
facebookToken	String
facebookTokenIssuedAt	ISO8601DateTime
firstName	String
gender	String
id	ID!
isAdmin	Boolean!
lastName	String
name	String
photo	Photo
updatedAt	ISO8601DateTime!
venueLastAt	ISO8601DateTime

Venue

Object · implements HasCover, HasPhoto, HasTimestamps

Field	Type	Description
coverImageUrl	PhotoURL
createdAt	ISO8601DateTime!
distanceTolerance	Int!
hidden	Boolean!
id	ID!
locale	Locale!
location	Location
order	Int!
page	Page!
photoUrl	PhotoURL
updatedAt	ISO8601DateTime!

Mutation payloads

AudienceThemeUpdatePayload

Object

Autogenerated return type of AudienceThemeUpdate.

Field	Type	Description
audience	Audience!	Audience that was updated.
clientMutationId	String	A unique identifier for the client performing the mutation.

AudienceUpdatePayload

Object

Autogenerated return type of AudienceUpdate.

Field	Type	Description
audience	Audience!	Audience that was updated.
clientMutationId	String	A unique identifier for the client performing the mutation.

LocaleCreatePayload

Object

Autogenerated return type of LocaleCreate.

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
createLocale	Locale!

PersonCreatePayload

Object

Autogenerated return type of PersonCreate.

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
person	Person!

PersonUpdatePayload

Object

Autogenerated return type of PersonUpdate.

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
updatePerson	Person!

VenueCreatePayload

Object

Autogenerated return type of VenueCreate.

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
venue	Venue!	The Venue that was created.

Inputs

AudienceInput

Input

Field	Type	Description
name	String
subdomain	String

AudienceThemeInput

Input

An audience’s design system preset, tagline and color overrides.

Field	Type	Description
dark	[ThemeTokenInput!]	Token overrides for dark mode.
light	[ThemeTokenInput!]	Token overrides for light mode.
preset	String!	Design system preset, e.g. default or hot_mess.
tagline	String	One line about the audience, in its own voice.

AudienceThemeUpdateInput

Input

Autogenerated input type of AudienceThemeUpdate

Field	Type	Description
audienceId	ID	The ID of the audience. Defaults to the endpoint audience.
clientMutationId	String	A unique identifier for the client performing the mutation.
theme	AudienceThemeInput!	The new theme.

AudienceUpdateInput

Input

Autogenerated input type of AudienceUpdate

Field	Type	Description
audienceId	ID	The ID of the audience. Defaults to the endpoint audience.
audienceInput	AudienceInput!	Fields to change.
clientMutationId	String	A unique identifier for the client performing the mutation.

LocaleCreateInput

Input

Autogenerated input type of LocaleCreate

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
createLocaleInput	LocaleInput!

LocaleInput

Input

Field	Type	Description
audienceId	ID
beaconMajor	Int
cityNames	String
createdAt	ISO8601DateTime
envelope	Geography
id	ID
label	String
locationId	ID
name	String
timezoneZuluDelta	Int
updatedAt	ISO8601DateTime

PersonCreateInput

Input

Autogenerated input type of PersonCreate

Field	Type	Description
audienceId	ID	The ID of the audience. Defaults to the endpoint audience.
clientMutationId	String	A unique identifier for the client performing the mutation.
personInput	PersonInput!

PersonInput

Input

Field	Type	Description
audienceId	ID
facebookId	Int
global	Boolean
id	ID
likeRequired	Boolean
order	Int
pageId	ID

PersonUpdateInput

Input

Autogenerated input type of PersonUpdate

Field	Type	Description
clientMutationId	String	A unique identifier for the client performing the mutation.
id	ID!
updatePersonInput	PersonInput!

ThemeTokenInput

Input

One color token override.

Field	Type	Description
name	String!	Token name, e.g. accent or spectrum-1.
value	String!	Hex color, e.g. #b8236f.

VenueCreateInput

Input

Autogenerated input type of VenueCreate

Field	Type	Description
audienceId	ID	The ID of the audience. Defaults to the endpoint audience.
clientMutationId	String	A unique identifier for the client performing the mutation.
venueInput	VenueInput!	The venue input

VenueInput

Input

Field	Type	Description
distanceTolerance	Int
facebookId	Int
hidden	Boolean
locationId	ID
order	Int
pageId	ID

Interfaces

HasCover

Interface

Field	Type	Description
coverImageUrl	PhotoURL

HasPhoto

Interface

Field	Type	Description
photoUrl	PhotoURL

HasTimestamps

Interface

Field	Type	Description
createdAt	ISO8601DateTime!
updatedAt	ISO8601DateTime!

Node

Interface

An object with an ID.

Field	Type	Description
id	ID!	ID of the object.

Scalars

Binary

Scalar

Geography

Scalar

GeoJSON

Scalar

ISO8601DateTime

Scalar

An ISO 8601-encoded datetime

JSON

Scalar

Represents untyped JSON

PhotoURL

Scalar