Skip to content

Queries

Queries are used to fetch data from the GraphQL API.

authData

Namespaced container for authoritative data queries.

graphql
authData: AuthDataQuery

Returns: AuthDataQuery

getAllAreas

Deprecated

Deprecated. Use authData { getAllAreas } instead.

Get all areas.

graphql
getAllAreas(criteria: GetAllAreasCriteriaInput): GetAllAreasResult

Arguments

NameTypeDescription
criteriaGetAllAreasCriteriaInputCriteria for searching areas.

Returns: GetAllAreasResult

getAllContinents

Deprecated

Deprecated. Use authData { getAllContinents } instead.

Get all continents.

graphql
getAllContinents(criteria: GetAllContinentsCriteriaInput): GetAllContinentsResult

Arguments

NameTypeDescription
criteriaGetAllContinentsCriteriaInputCriteria for searching continents.

Returns: GetAllContinentsResult

getAllCountries

Deprecated

Deprecated. Use authData { getAllCountries } instead.

Get all countries.

graphql
getAllCountries(criteria: GetAllCountriesCriteriaInput): GetAllCountriesResult

Arguments

NameTypeDescription
criteriaGetAllCountriesCriteriaInputCriteria for searching countries.

Returns: GetAllCountriesResult

getAllDepartments

Deprecated

Deprecated. Use authData { getAllDepartments } instead.

Get all departments.

graphql
getAllDepartments(criteria: GetAllDepartmentsCriteriaInput): GetAllDepartmentsResult

Arguments

NameTypeDescription
criteriaGetAllDepartmentsCriteriaInputCriteria for searching departments.

Returns: GetAllDepartmentsResult

getAllEnums

Deprecated

Deprecated. Use authData { getAllEnums } instead.

Retrieve all enum names defined in the GraphQL schema.

graphql
getAllEnums: EnumGetAllResultShape!

Returns: EnumGetAllResultShape!

getAllEventSeriesTypes

Deprecated

Deprecated. Use authData { getAllEventSeriesTypes } instead.

Retrieves all event series types available.

graphql
getAllEventSeriesTypes(criteria: EventSeriesTypesGetAllCriteriaInput): EventSeriesTypesGetAllResult!

Arguments

NameTypeDescription
criteriaEventSeriesTypesGetAllCriteriaInputCriteria for getting all event series types.

Returns: EventSeriesTypesGetAllResult!

getAllExternalRecords

Deprecated

Deprecated. Use authData { getAllExternalRecords } instead.

Get all external records filtered by record type.

graphql
getAllExternalRecords(criteria: GetAllExternalRecordsCriteriaInput!): GetAllExternalRecordsResult

Arguments

NameTypeDescription
criteriaGetAllExternalRecordsCriteriaInput!Criteria for searching external records.

Returns: GetAllExternalRecordsResult

getAllExternalTeamRoles

Deprecated

Deprecated. Use authData { getAllExternalTeamRoles } instead.

Get all external team roles.

graphql
getAllExternalTeamRoles(criteria: GetAllExternalTeamRolesCriteriaInput): GetAllExternalTeamRolesResult

Arguments

NameTypeDescription
criteriaGetAllExternalTeamRolesCriteriaInputCriteria for filtering external team roles.

Returns: GetAllExternalTeamRolesResult

getAllGenres

Deprecated

Deprecated. Use authData { getAllGenres } instead.

Get all Genres

graphql
getAllGenres(criteria: GetAllGenresCriteriaInput): GetAllGenresResult

Arguments

NameTypeDescription
criteriaGetAllGenresCriteriaInputCriteria for searching genres.

Returns: GetAllGenresResult

getAllHighlights

Deprecated

Deprecated. Use authData { getAllHighlights } instead.

Get all Highlights

graphql
getAllHighlights(criteria: GetAllHighlightsCriteriaInput): GetAllHighlightsResult

Arguments

NameTypeDescription
criteriaGetAllHighlightsCriteriaInputCriteria for searching highlights.

Returns: GetAllHighlightsResult

getAllInterests

Deprecated

Deprecated. Use authData { getAllInterests } instead.

Get all Interests

graphql
getAllInterests(criteria: GetAllInterestsCriteriaInput): GetAllInterestsResult

Arguments

NameTypeDescription
criteriaGetAllInterestsCriteriaInputCriteria for searching interests.

Returns: GetAllInterestsResult

getAllJobRoles

Deprecated

Deprecated. Use authData { getAllJobRoles } instead.

Get all job roles.

graphql
getAllJobRoles(criteria: GetAllJobRolesCriteriaInput): GetAllJobRolesResult

Arguments

NameTypeDescription
criteriaGetAllJobRolesCriteriaInputCriteria for filtering job roles.

Returns: GetAllJobRolesResult

getAllLanguages

Deprecated

Deprecated. Use authData { getAllLanguages } instead.

Get all languages.

graphql
getAllLanguages(criteria: GetAllLanguagesCriteriaInput): GetAllLanguagesResult

Arguments

NameTypeDescription
criteriaGetAllLanguagesCriteriaInputCriteria for searching languages.

Returns: GetAllLanguagesResult

getAllMedia

Deprecated

Deprecated. Use authData { getAllMedia } instead.

Get all Media

graphql
getAllMedia(criteria: GetAllMediaCriteriaInput): GetAllMediaResult

Arguments

NameTypeDescription
criteriaGetAllMediaCriteriaInputCriteria for searching media.

Returns: GetAllMediaResult

getAllMiscs

Deprecated

Deprecated. Use authData { getAllMiscs } instead.

Get all Miscs

graphql
getAllMiscs(criteria: GetAllMiscsCriteriaInput): GetAllMiscsResult

Arguments

NameTypeDescription
criteriaGetAllMiscsCriteriaInputCriteria for searching miscs.

Returns: GetAllMiscsResult

getAllMusicGenres

Deprecated

Deprecated. Use authData { getAllMusicGenres } instead.

Get all music genres.

graphql
getAllMusicGenres(criteria: GetAllMusicGenresCriteriaInput): GetAllMusicGenresResult

Arguments

NameTypeDescription
criteriaGetAllMusicGenresCriteriaInputCriteria for searching music genres.

Returns: GetAllMusicGenresResult

getAllPlayableAges

Deprecated

Deprecated. Use authData { getAllPlayableAges } instead.

Get all PlayableAges

graphql
getAllPlayableAges(criteria: GetAllPlayableAgesCriteriaInput): GetAllPlayableAgesResult

Arguments

NameTypeDescription
criteriaGetAllPlayableAgesCriteriaInputCriteria for searching playableAges.

Returns: GetAllPlayableAgesResult

getAllRegions

Deprecated

Deprecated. Use authData { getAllRegions } instead.

Get all regions.

graphql
getAllRegions(criteria: GetAllRegionsCriteriaInput): GetAllRegionsResult

Arguments

NameTypeDescription
criteriaGetAllRegionsCriteriaInputCriteria for searching regions.

Returns: GetAllRegionsResult

getAllRepAreas

Deprecated

Deprecated. Use authData { getAllRepAreas } instead.

Get all representation areas.

graphql
getAllRepAreas(criteria: GetAllRepAreasCriteriaInput): GetAllRepAreasResult

Arguments

NameTypeDescription
criteriaGetAllRepAreasCriteriaInputCriteria for searching representation areas.

Returns: GetAllRepAreasResult

getAllRoles

Deprecated

Deprecated. Use authData { getAllRoles } instead.

Get all roles.

graphql
getAllRoles(criteria: GetAllRolesCriteriaInput): GetAllRolesResult

Arguments

NameTypeDescription
criteriaGetAllRolesCriteriaInputCriteria for searching roles.

Returns: GetAllRolesResult

getAllSkills

Deprecated

Deprecated. Use authData { getAllSkills } instead.

Get all Skills

graphql
getAllSkills(criteria: GetAllSkillsCriteriaInput): GetAllSkillsResult

Arguments

NameTypeDescription
criteriaGetAllSkillsCriteriaInputCriteria for searching skills.

Returns: GetAllSkillsResult

getAllTerritories

Deprecated

Deprecated. Use authData { getAllTerritories } instead.

Get all territories with pagination and sorting

graphql
getAllTerritories(criteria: GetAllTerritoriesCriteriaInput): GetAllTerritoriesResult

Arguments

NameTypeDescription
criteriaGetAllTerritoriesCriteriaInputCriteria for getting territories

Returns: GetAllTerritoriesResult

getAllVenueTypes

Deprecated

Deprecated. Use authData { getAllVenueTypes } instead.

Retrieves all venue types available.

graphql
getAllVenueTypes(criteria: VenueTypesGetAllCriteriaInput): VenueTypesGetAllResult!

Arguments

NameTypeDescription
criteriaVenueTypesGetAllCriteriaInputCriteria for getting all venue types.

Returns: VenueTypesGetAllResult!

getAllVocations

Deprecated

Deprecated. Use authData { getAllVocations } instead.

Get all Vocations

graphql
getAllVocations(criteria: GetAllVocationsCriteriaInput): GetAllVocationsResult

Arguments

NameTypeDescription
criteriaGetAllVocationsCriteriaInputCriteria for searching vocations.

Returns: GetAllVocationsResult

getAllWorkPapers

Deprecated

Deprecated. Use authData { getAllWorkPapers } instead.

Get all WorkPapers

graphql
getAllWorkPapers(criteria: GetAllWorkPapersCriteriaInput): GetAllWorkPapersResult

Arguments

NameTypeDescription
criteriaGetAllWorkPapersCriteriaInputCriteria for searching workPapers.

Returns: GetAllWorkPapersResult

helperExternalRecordTypeMetadata

Deprecated

Deprecated. Use authData { helperExternalRecordTypeMetadata } instead.

Get metadata about how each external record type should be used, including field requirements.

graphql
helperExternalRecordTypeMetadata: [ExternalRecordTypeMetadata!]

Returns: [ExternalRecordTypeMetadata!]

lookupBuyers

Deprecated

Deprecated. Use authData { lookupBuyers } instead.

graphql
lookupBuyers(criteria: LookupCriteriaInput!): [Buyer!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup buyers by a list of IDs and/or External IDs.

Returns: [Buyer!]

lookupClients

Deprecated

Deprecated. Use authData { lookupClients } instead.

graphql
lookupClients(criteria: LookupCriteriaInput!): [Client!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup clients by a list of IDs and/or External IDs.

Returns: [Client!]

lookupContacts

Deprecated

Deprecated. Use authData { lookupContacts } instead.

graphql
lookupContacts(criteria: LookupCriteriaInput!): [Contact!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup contacts by a list of IDs and/or External IDs.

Returns: [Contact!]

lookupEmployees

Deprecated

Deprecated. Use authData { lookupEmployees } instead.

graphql
lookupEmployees(criteria: LookupCriteriaInput!): [Employee!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup employees by a list of IDs and/or External IDs.

Returns: [Employee!]

lookupEventInstance

Deprecated

Deprecated. Use authData { lookupEventInstance } instead.

graphql
lookupEventInstance(criteria: LookupCriteriaInput!): [EventInstance!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup Event Instances by a list of IDs and/or External IDs.

Returns: [EventInstance!]

lookupEventSeries

Deprecated

Deprecated. Use authData { lookupEventSeries } instead.

graphql
lookupEventSeries(criteria: LookupCriteriaInput!): [EventSeries!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup Event Series by a list of IDs or External IDs.

Returns: [EventSeries!]

lookupParties

Deprecated

Deprecated. Use authData { lookupParties } instead.

graphql
lookupParties(criteria: LookupCriteriaInput!): [SuperParty!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup parties by a list of IDs and/or External IDs.

Returns: [SuperParty!]

lookupVenues

Deprecated

Deprecated. Use authData { lookupVenues } instead.

graphql
lookupVenues(criteria: LookupCriteriaInput!): [Venue!]

Arguments

NameTypeDescription
criteriaLookupCriteriaInput!Lookup venues by a list of IDs or External IDs.

Returns: [Venue!]

precheckBuyer

Deprecated

Deprecated. Use authData { precheckBuyer } instead.

Validates the input for createBuyer and returns potential duplicates for review.

graphql
precheckBuyer(input: BuyerCreateInput!): [PartyPrecheckResult!]

Arguments

NameTypeDescription
inputBuyerCreateInput!The buyer fields necessary for creation

Returns: [PartyPrecheckResult!]

precheckClient

Deprecated

Deprecated. Use authData { precheckClient } instead.

Validates the input for createClient and returns potential duplicates for review.

graphql
precheckClient(input: ClientCreateInput!): [PartyPrecheckResult!]

Arguments

NameTypeDescription
inputClientCreateInput!The client fields necessary for creation

Returns: [PartyPrecheckResult!]

precheckContact

Deprecated

Deprecated. Use authData { precheckContact } instead.

Validates the input for createContact and returns potential duplicates for review.

graphql
precheckContact(input: ContactCreateInput!): [PartyPrecheckResult!]

Arguments

NameTypeDescription
inputContactCreateInput!The contact fields necessary for creation

Returns: [PartyPrecheckResult!]

precheckTalent

Deprecated

Deprecated. Use authData { precheckTalent } instead.

Validates the input for createTalent and returns potential duplicates for review.

graphql
precheckTalent(input: TalentCreateInput!): [PartyPrecheckResult!]

Arguments

NameTypeDescription
inputTalentCreateInput!The talent fields necessary for creation

Returns: [PartyPrecheckResult!]

precheckVenue

Deprecated

Deprecated. Use authData { precheckVenue } instead.

Validates the input for the createVenue mutation and returns potential duplicates for review.

graphql
precheckVenue(input: VenueCreateInput!): [VenuePrecheckResult!]

Arguments

NameTypeDescription
inputVenueCreateInput!The venue fields necessary for creation

Returns: [VenuePrecheckResult!]

searchBuyers

Deprecated

Deprecated. Use authData { searchBuyers } instead.

Search buyers by a term.

graphql
searchBuyers(criteria: BuyerSearchCriteriaInput): BuyerSearchResult

Arguments

NameTypeDescription
criteriaBuyerSearchCriteriaInputCriteria for searching buyers.

Returns: BuyerSearchResult

searchClients

Deprecated

Deprecated. Use authData { searchClients } instead.

Search clients by a term.

graphql
searchClients(criteria: ClientSearchCriteriaInput): ClientSearchResult

Arguments

NameTypeDescription
criteriaClientSearchCriteriaInputCriteria for searching clients.

Returns: ClientSearchResult

searchContacts

Deprecated

Deprecated. Use authData { searchContacts } instead.

Search contacts by a term.

graphql
searchContacts(criteria: ContactSearchCriteriaInput): ContactSearchResult

Arguments

NameTypeDescription
criteriaContactSearchCriteriaInputCriteria for searching contacts.

Returns: ContactSearchResult

searchEventSeries

Deprecated

Deprecated. Use authData { searchEventSeries } instead.

Search event series by a term.

graphql
searchEventSeries(criteria: EventSeriesSearchCriteriaInput): EventSeriesSearchResult

Arguments

NameTypeDescription
criteriaEventSeriesSearchCriteriaInputCriteria for searching event series.

Returns: EventSeriesSearchResult

searchParties

Deprecated

Deprecated. Use authData { searchParties } instead.

Search parties by a term.

graphql
searchParties(criteria: PartySearchCriteriaInput): PartySearchResult

Arguments

NameTypeDescription
criteriaPartySearchCriteriaInputCriteria for searching parties.

Returns: PartySearchResult

searchVenues

Deprecated

Deprecated. Use authData { searchVenues } instead.

Search venues by a term.

graphql
searchVenues(criteria: VenueSearchCriteriaInput): VenueSearchResult

Arguments

NameTypeDescription
criteriaVenueSearchCriteriaInputCriteria for searching venues.

Returns: VenueSearchResult

translateExternalRecords

Deprecated

Deprecated. Use authData { translateExternalRecords } instead.

graphql
translateExternalRecords(criteria: TranslateExternalRecordsInput!): [TranslateExternalRecordsResult!]

Arguments

NameTypeDescription
criteriaTranslateExternalRecordsInput!List of external records to translate.

Returns: [TranslateExternalRecordsResult!]

Confidential. For internal use only.