Newspark GraphQL API Documentation


Endpoint: https://v7.newspark.ca/gql
Type: GraphQL v1
Auth: (Not specified in schema – typically via Authorization header)


Root Schema

Query

  • Vhost: Get access to Projects methods
  • Applications: Interact with Application data
  • Users: User management and lookup
  • Transfers: File transfer services
  • Assets: Media asset operations
  • Channels: Channel hierarchy
  • Groups: User grouping and permissions
  • Authentication: Login and verification support

Mutation

(Details not included in your uploaded section — let me know if you’d like this added.)


Sample Query Structure

query {
  Users {
    user(id: 123) {
      id
      firstname
      email
    }
  }
}

Notable Object Types

MediaInfo

Details about an uploaded media file.

FieldTypeDescription
idStringUnique ID of the media
statusInt0=Pending, 1=Processing, 2=Complete, 3=Failed
filetypeInt0=Image, 1=Video, 2=Audio
filenameStringOriginal filename
filesizeBigIntFile size in bytes
contenttypeStringMIME type like "image/png"
uploadDateTimeTime of upload
tagsStringSpace-separated tag list
locationStringStorage type (Amazon S3, etc)
userUserInfoUploader’s details
publicUrlStringPublicly accessible link
thumbUrlStringThumbnail image URL

UserInfo

Describes an end user.

FieldTypeDescription
idIntUser ID
emailStringEmail address
firstname / lastnameStringUser’s name
citystatecountrypostalcodeStringAddress info
birthdateStringDate of birth
activedisabledBooleanAccount status
createdStringAccount creation date

Projects Queries

MethodDescription
vhost(id: Int!)Returns a MediaInfo object
getContentSummary(...)Aggregate counts by vhostchannelfileType, etc.
getUserSummary(...)Active/registered user breakdowns
getTotals(...)File usage and quota summaries

Users Queries

MethodReturnsDescription
user(id: Int!)UserInfoGet a user by ID
users(...)UserInfoFilter, sort, and paginate through users
checkSSO(userName, vhost)SSOResultCheck login for federated identity
sendVerificationCode(userId)UserInfoTriggers a verification email or SMS

🔧 Types and Filters

UserFilters Input

FieldTypeDescription
firstnamelastnameusercitycountryStringText filters
activedisabledBooleanAccount status
groupideventidnidInt or [Int]Association IDs
geodeviceGeoCenterStringGeolocation search
imFollowingfollowingMeBooleanSocial network behavior

ApplicationInfo

FieldTypeDescription
idIDUnique application ID
nameStringApplication name
maindomainStringMain domain
classStringApplication class/type
settingsApplicationSettingsNested settings object
emailStringAdmin/technical contact

Custom Scalars

  • BigInt: Represents large integer values (as strings)
  • DateTime: ISO 8601 UTC datetime
  • IDStringIntFloatBoolean: Standard GraphQL types

Pagination Example

Most queries support optional params like startlimit, and sort.

query {
  Users {
    users(vhost: 2, start: 0, limit: 10, sort: "CREATED DESC") {
      id
      firstname
      email
    }
  }
}

Testing the API

You can test this GraphQL API using:

Make requests to:

POST https://v7.newspark.ca/gql
Content-Type: application/json
Authorization: Bearer <your_token>

Would you like this exported as Markdown, HTML, or integrated into something like a Docusaurus or ReadMe.io layout? I can also refine descriptions for any other types you’re actively using.