LinkTaco

linktaco API Documentation

This is the GraphQL API documentation for LinkTaco. It was generated from the service's GraphQL Schema definition.

All API requests must be sent to https://api.linktaco.com/query. You can read more about this on the GraphQL on LinkTaco overview page.

Queries

analytics

@access(scope:ANALYTICS, kind:RO)

Returns analytics for various objects depending on input values

Returns Analytics!

Arguments
  1. input - AnalyticsInput!
Example Query 
query analytics($input: AnalyticsInput!) {
    analytics(input: $input) {
        title
        clicksOverTime {
            ...AnalyticData
        }
        clicksCountry {
            ...AnalyticData
        }
        clicksCity {
            ...AnalyticData
        }
        clicksDevice {
            ...AnalyticData
        }
        clicksReferrer {
            ...AnalyticData
        }
        listingLink {
            ...ListingLink
        }
        qrList {
            ...QRCode
        }
    }
}

getAdminBillingStats

@admin

Returns AdminBillingStats!

Arguments
  1. input - AdminBillingInput
Example Query 
query getAdminBillingStats($input: AdminBillingInput) {
    getAdminBillingStats(input: $input) {
        activeSubscriptions
        pendingCancelSubscriptions
        canceledSubscription
        newSubscribers
        totalAmount
        totalFee
        totalNet
        totalRefunded
    }
}

getAdminDomains

@admin

Returns DomainCursor!

Arguments
  1. input - GetAdminDomainInput
Example Query 
query getAdminDomains($input: GetAdminDomainInput) {
    getAdminDomains(input: $input) {
        result {
            ...Domain
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getAdminOrgStats

@admin

Returns OrganizationStats!

Arguments
  1. id - Int!
Example Query 
query getAdminOrgStats($id: Int!) {
    getAdminOrgStats(id: $id) {
        links
        lists
        shorts
    }
}

getAdminOrganizations

@admin

Returns OrganizationCursor!

Arguments
  1. input - GetAdminOrganizationsInput
Example Query 
query getAdminOrganizations($input: GetAdminOrganizationsInput) {
    getAdminOrganizations(input: $input) {
        result {
            ...Organization
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getAuditLogs

@access(scope:PROFILE, kind:RO)

Returns audit log entries for given parameters

Returns AuditLogCursor!

Arguments
  1. input - AuditLogInput
Example Query 
query getAuditLogs($input: AuditLogInput) {
    getAuditLogs(input: $input) {
        result {
            ...AuditLog
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getBookmarks

@access(scope:LINKS, kind:RO)

Returns saved links (bookmarks) for a given URL. Accepts BaseURL hash or full url

Returns BookmarkCursor!

Arguments
  1. hash - String!
  2. tags - String
Example Query 
query getBookmarks($hash: String!, $tags: String) {
    getBookmarks(hash: $hash, tags: $tags) {
        result {
            ...OrgLink
        }
        title
        description
        url
        count
        tagCloud {
            ...Tag
        }
    }
}

getDomain

@access(scope:DOMAINS, kind:RO)

Returns a specific domain

Returns Domain!

Arguments
  1. id - Int!
Example Query 
query getDomain($id: Int!) {
    getDomain(id: $id) {
        id
        name
        lookupName
        orgId {
            ...NullInt
        }
        orgSlug {
            ...NullString
        }
        service
        level
        status
        isActive
        createdOn
        updatedOn
    }
}

getDomains

@access(scope:DOMAINS, kind:RO)

Returns custom domains of an organization

Returns [Domain]!

Arguments
  1. orgSlug - String
  2. service - DomainService
Example Query 
query getDomains($orgSlug: String, $service: DomainService) {
    getDomains(orgSlug: $orgSlug, service: $service) {
        id
        name
        lookupName
        orgId {
            ...NullInt
        }
        orgSlug {
            ...NullString
        }
        service
        level
        status
        isActive
        createdOn
        updatedOn
    }
}

getFeed

@access(scope:PROFILE, kind:RO)

Returns an array of organization links from the calling users feed (orgs they follow)

Returns OrgLinkCursor!

Arguments
  1. input - GetFeedInput
Example Query 
query getFeed($input: GetFeedInput) {
    getFeed(input: $input) {
        result {
            ...OrgLink
        }
        pageInfo {
            ...PageInfo
        }
        restrictedCount
        tagCloud {
            ...Tag
        }
    }
}

getFeedFollowing

@access(scope:PROFILE, kind:RO)

Returns an array of organizations that the calling user follows

Returns [Organization]!

Example Query 
query getFeedFollowing {
    getFeedFollowing {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

getLinkShort

@access(scope:SHORTS, kind:RO)

Returns a specific short link

Returns LinkShort!

Arguments
  1. shortCode - String!
  2. domainId - Int
Example Query 
query getLinkShort($shortCode: String!, $domainId: Int) {
    getLinkShort(shortCode: $shortCode, domainId: $domainId) {
        id
        title
        url
        shortCode
        tags {
            ...Tag
        }
        userId
        domainId
        orgId
        lookupName
        createdOn
        updatedOn
    }
}

getLinkShorts

@access(scope:SHORTS, kind:RO)

Returns an array of short links

Returns LinkShortCursor!

Arguments
  1. input - GetLinkShortInput
Example Query 
query getLinkShorts($input: GetLinkShortInput) {
    getLinkShorts(input: $input) {
        result {
            ...LinkShort
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getListing

@access(scope:LISTS, kind:RO)

Returns a specific link listing

Returns ListingLinkCursor!

Arguments
  1. input - GetListingDetailInput
Example Query 
query getListing($input: GetListingDetailInput) {
    getListing(input: $input) {
        result {
            ...Listing
        }
        links {
            ...ListingLink
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getListings

@access(scope:LISTS, kind:RO)

Returns an array of link listings

Returns ListingCursor!

Arguments
  1. input - GetListingInput
Example Query 
query getListings($input: GetListingInput) {
    getListings(input: $input) {
        result {
            ...Listing
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getOrgMembers

@access(scope:ORGS, kind:RO)

Returns members of an organization

Returns [User]!

Arguments
  1. orgSlug - String!
Example Query 
query getOrgMembers($orgSlug: String!) {
    getOrgMembers(orgSlug: $orgSlug) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

getOrganization

@access(scope:ORGS, kind:RO)

Returns a specific organization

Returns Organization

Arguments
  1. slug - String!
Example Query 
query getOrganization($slug: String!) {
    getOrganization(slug: $slug) {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

getOrganizations

@access(scope:ORGS, kind:RO)

Returns an array of organizations

Returns [Organization]!

Arguments
  1. input - GetOrganizationsInput
Example Query 
query getOrganizations($input: GetOrganizationsInput) {
    getOrganizations(input: $input) {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

getPaymentHistory

@access(scope:BILLING, kind:RO)

Returns payment history based on given input

Returns PaymentCursor!

Arguments
  1. input - GetPaymentInput
Example Query 
query getPaymentHistory($input: GetPaymentInput) {
    getPaymentHistory(input: $input) {
        result {
            ...Payment
        }
        pageInfo {
            ...PageInfo
        }
    }
}

getQRDetail

@access(scope:QRCODES, kind:RO)

Returns a specific QR code

Returns QRCode!

Arguments
  1. hashId - String!
  2. orgSlug - String
Example Query 
query getQRDetail($hashId: String!, $orgSlug: String) {
    getQRDetail(hashId: $hashId, orgSlug: $orgSlug) {
        id
        title
        orgId
        codeType
        url
        imagePath
        hashId
        createdOn
        clicks
    }
}

getQRList

@access(scope:QRCODES, kind:RO)

Returns an array of QR codes

Returns [QRObject]!

Arguments
  1. orgSlug - String!
  2. codeType - QRCodeType!
  3. elementId - Int!
Example Query 
query getQRList($orgSlug: String!, $codeType: QRCodeType!, $elementId: Int!) {
    getQRList(orgSlug: $orgSlug, codeType: $codeType, elementId: $elementId) {
        qrCodeId
        qrHashId
        userId
        createdOn
        title
    }
}

getUser

@admin

Returns User!

Arguments
  1. id - Int!
Example Query 
query getUser($id: Int!) {
    getUser(id: $id) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

getUsers

@admin

Returns UserCursor!

Arguments
  1. input - GetUserInput
Example Query 
query getUsers($input: GetUserInput) {
    getUsers(input: $input) {
        result {
            ...User
        }
        pageInfo {
            ...PageInfo
        }
    }
}

me

@access(scope:PROFILE, kind:RO)

Returns the authenticated user.

Returns User!

Example Query 
query me {
    me {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

version

Returns API version information.

Returns Version!

Example Query 
query version {
    version {
        major
        minor
        patch
        deprecationDate
    }
}

Mutations

addAdminDomain

@admin

Returns Domain!

Arguments
  1. input - AdminDomainInput!
Example Query 
query addAdminDomain($input: AdminDomainInput!) {
    addAdminDomain(input: $input) {
        id
        name
        lookupName
        orgId {
            ...NullInt
        }
        orgSlug {
            ...NullString
        }
        service
        level
        status
        isActive
        createdOn
        updatedOn
    }
}

addDomain

@access(scope:DOMAINS, kind:RW)

Manage custom domains for an organization

Returns Domain!

Arguments
  1. input - DomainInput!
Example Query 
query addDomain($input: DomainInput!) {
    addDomain(input: $input) {
        id
        name
        lookupName
        orgId {
            ...NullInt
        }
        orgSlug {
            ...NullString
        }
        service
        level
        status
        isActive
        createdOn
        updatedOn
    }
}

addLinkShort

@access(scope:SHORTS, kind:RW)

Add/Edit/Delete short links

Returns LinkShort!

Arguments
  1. input - LinkShortInput
Example Query 
query addLinkShort($input: LinkShortInput) {
    addLinkShort(input: $input) {
        id
        title
        url
        shortCode
        tags {
            ...Tag
        }
        userId
        domainId
        orgId
        lookupName
        createdOn
        updatedOn
    }
}

addListing

@access(scope:LISTS, kind:RW)

Add/Edit/Delete link listings and their individual links

Returns Listing!

Arguments
  1. input - AddListingInput
Example Query 
query addListing($input: AddListingInput) {
    addListing(input: $input) {
        id
        title
        slug
        image
        metadata {
            ...Metadata
        }
        isActive
        isDefault
        tags {
            ...Tag
        }
        userId
        orgId
        domainId
        lookupName
        createdOn
        updatedOn
    }
}

addMember

@access(scope:ORGS, kind:RW)

Add organization members

Returns AddMemberPayload!

Arguments
  1. input - MemberInput
Example Query 
query addMember($input: MemberInput) {
    addMember(input: $input) {
        success
        message
    }
}

addNote

@access(scope:LINKS, kind:RW)

Add organization note

Returns OrgLink!

Arguments
  1. input - NoteInput
Example Query 
query addNote($input: NoteInput) {
    addNote(input: $input) {
        id
        title
        description
        url
        hash
        baseUrlId
        orgId
        userId
        visibility
        unread
        starred
        archiveUrl
        type
        tags {
            ...Tag
        }
        author
        orgSlug
        createdOn
        updatedOn
        baseUrlData {
            ...BaseURLData
        }
        baseUrlCounter
        baseUrlHash
    }
}

addOrganization

@access(scope:ORGS, kind:RW)

Create a new organization

Returns Organization!

Arguments
  1. input - OrganizationInput!
Example Query 
query addOrganization($input: OrganizationInput!) {
    addOrganization(input: $input) {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

addQRCode

@access(scope:QRCODES, kind:RW)

Add/Delete QR codes from short links and link listings

Returns QRCode!

Arguments
  1. input - AddQRCodeInput!
Example Query 
query addQRCode($input: AddQRCodeInput!) {
    addQRCode(input: $input) {
        id
        title
        orgId
        codeType
        url
        imagePath
        hashId
        createdOn
        clicks
    }
}

completeRegister

@access(scope:PROFILE, kind:RW)

Returns User!

Arguments
  1. input - CompleteRegisterInput
Example Query 
query completeRegister($input: CompleteRegisterInput) {
    completeRegister(input: $input) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

confirmMember

@access(scope:PROFILE, kind:RW)

Returns AddMemberPayload!

Arguments
  1. key - String!
Example Query 
query confirmMember($key: String!) {
    confirmMember(key: $key) {
        success
        message
    }
}

deleteDomain

@access(scope:DOMAINS, kind:RW)

Returns DeletePayload!

Arguments
  1. id - Int!
Example Query 
query deleteDomain($id: Int!) {
    deleteDomain(id: $id) {
        success
        objectId
        message
    }
}

deleteLinkShort

@access(scope:SHORTS, kind:RW)

Returns DeletePayload!

Arguments
  1. id - Int!
Example Query 
query deleteLinkShort($id: Int!) {
    deleteLinkShort(id: $id) {
        success
        objectId
        message
    }
}

deleteListing

@access(scope:LISTS, kind:RW)

Returns DeletePayload!

Arguments
  1. id - Int!
Example Query 
query deleteListing($id: Int!) {
    deleteListing(id: $id) {
        success
        objectId
        message
    }
}

deleteMember

@access(scope:ORGS, kind:RW)

Returns AddMemberPayload!

Arguments
  1. orgSlug - String!
  2. email - String!
Example Query 
query deleteMember($orgSlug: String!, $email: String!) {
    deleteMember(orgSlug: $orgSlug, email: $email) {
        success
        message
    }
}

deleteQRCode

@access(scope:QRCODES, kind:RW)

Returns DeletePayload!

Arguments
  1. id - Int!
Example Query 
query deleteQRCode($id: Int!) {
    deleteQRCode(id: $id) {
        success
        objectId
        message
    }
}

follow

@access(scope:PROFILE, kind:RW)

Un/Follow an organization as the calling user

Returns FollowPayload!

Arguments
  1. orgSlug - String!
Example Query 
query follow($orgSlug: String!) {
    follow(orgSlug: $orgSlug) {
        success
        message
    }
}

register

@internal

Register an account

Returns User!

Arguments
  1. input - RegisterInput
Example Query 
query register($input: RegisterInput) {
    register(input: $input) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

sendRegisterInvitation

@admin

Returns RegisterInvitation!

Arguments
  1. toEmail - String!
Example Query 
query sendRegisterInvitation($toEmail: String!) {
    sendRegisterInvitation(toEmail: $toEmail) {
        email
    }
}

unfollow

@access(scope:PROFILE, kind:RW)

Returns FollowPayload!

Arguments
  1. orgSlug - String!
Example Query 
query unfollow($orgSlug: String!) {
    unfollow(orgSlug: $orgSlug) {
        success
        message
    }
}

updateAdminDomain

@admin

Returns Domain!

Arguments
  1. input - UpdateAdminDomainInput!
Example Query 
query updateAdminDomain($input: UpdateAdminDomainInput!) {
    updateAdminDomain(input: $input) {
        id
        name
        lookupName
        orgId {
            ...NullInt
        }
        orgSlug {
            ...NullString
        }
        service
        level
        status
        isActive
        createdOn
        updatedOn
    }
}

updateAdminOrgType

@admin

Returns Organization!

Arguments
  1. orgSlug - String!
  2. orgType - OrgBillingStatus!
Example Query 
query updateAdminOrgType($orgSlug: String!, $orgType: OrgBillingStatus!) {
    updateAdminOrgType(orgSlug: $orgSlug, orgType: $orgType) {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

updateAdminUser

@admin

Returns User!

Arguments
  1. input - UpdateUserInput
Example Query 
query updateAdminUser($input: UpdateUserInput) {
    updateAdminUser(input: $input) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

updateLinkShort

@access(scope:SHORTS, kind:RW)

Returns LinkShort!

Arguments
  1. input - UpdateLinkShortInput
Example Query 
query updateLinkShort($input: UpdateLinkShortInput) {
    updateLinkShort(input: $input) {
        id
        title
        url
        shortCode
        tags {
            ...Tag
        }
        userId
        domainId
        orgId
        lookupName
        createdOn
        updatedOn
    }
}

updateListing

@access(scope:LISTS, kind:RW)

Returns Listing!

Arguments
  1. input - UpdateListingInput
Example Query 
query updateListing($input: UpdateListingInput) {
    updateListing(input: $input) {
        id
        title
        slug
        image
        metadata {
            ...Metadata
        }
        isActive
        isDefault
        tags {
            ...Tag
        }
        userId
        orgId
        domainId
        lookupName
        createdOn
        updatedOn
    }
}

updateOrganization

@access(scope:ORGS, kind:RW)

Update organization details

Returns Organization!

Arguments
  1. input - UpdateOrganizationInput
Example Query 
query updateOrganization($input: UpdateOrganizationInput) {
    updateOrganization(input: $input) {
        id
        ownerId
        orgType
        name
        slug
        image
        timezone
        settings {
            ...OrganizationSettings
        }
        isActive
        createdOn
        updatedOn
        ownerName
    }
}

updateProfile

@access(scope:PROFILE, kind:RW)

Update user profile

Returns User!

Arguments
  1. input - ProfileInput
Example Query 
query updateProfile($input: ProfileInput) {
    updateProfile(input: $input) {
        id
        name
        email
        createdOn
        isEmailVerified
        isLocked
        lockReason
    }
}

Definitions

AccessKind

Enum Values
  1. RO
  2. RW

AccessScope

Enum Values
  1. PROFILE
  2. LINKS
  3. LISTS
  4. SHORTS
  5. ORGS
  6. DOMAINS
  7. BILLING
  8. ANALYTICS
  9. QRCODES

AddListingInput

Fields
  1. title - String!
  2. slug - String!
  3. image - Upload
  4. domainId - Int!
  5. isDefault - Boolean!
  6. orgSlug - String!
  7. tags - String
  8. fediverse - String
  9. bluesky - String
  10. facebook - String
  11. twitter - String
  12. tiktok - String
  13. youtube - String
  14. instagram - String

AddListingLinkInput

Fields
  1. title - String!
  2. listingSlug - String!
  3. domainId - Int!
  4. linkOrder - Int!
  5. url - String!
  6. description - String

AddMemberPayload

Fields
  1. success - Boolean!
  2. message - String!

AddQRCodeInput

Fields
  1. title - String!
  2. orgSlug - String!
  3. codeType - QRCodeType!
  4. elementId - Int!
  5. image - Upload

AdminBillingInput

Fields
  1. orgSlug - String
  2. interval - Int
  3. dateStart - String
  4. dateEnd - String

AdminBillingStats

Fields
  1. activeSubscriptions - Int!
  2. pendingCancelSubscriptions - Int!
  3. canceledSubscription - Int!
  4. newSubscribers - Int!
  5. totalAmount - Int!
  6. totalFee - Int!
  7. totalNet - Int!
  8. totalRefunded - Int!

AdminDomainInput

Fields
  1. name - String!
  2. lookupName - String!
  3. orgSlug - String
  4. service - DomainService!
  5. level - DomainLevel!
  6. status - DomainStatus!
  7. isActive - Boolean!
  8. migrateLinks - Boolean

AnalyticData

Fields
  1. key - String!
  2. val - Int!

Analytics

Fields
  1. title - String!
  2. clicksOverTime - [AnalyticData]!
  3. clicksCountry - [AnalyticData]!
  4. clicksCity - [AnalyticData]!
  5. clicksDevice - [AnalyticData]!
  6. clicksReferrer - [AnalyticData]!
  7. listingLink - [ListingLink]
  8. qrList - [QRCode]

AnalyticsInput

Fields
  1. id - Int!
  2. orgSlug - String!
  3. type - String!
  4. interval - String
  5. dateStart - String
  6. dateEnd - String

AuditLog

Fields
  1. userId - Int!
  2. ipAddress - String!
  3. eventType - String!
  4. details - String
  5. metadata - Map
  6. createdOn - Time!

AuditLogCursor

Fields
  1. result - [AuditLog]!
  2. pageInfo - PageInfo

AuditLogInput

Fields
  1. userId - Int
  2. orgSlug - String
  3. listingId - Int
  4. after - Cursor
  5. before - Cursor
  6. limit - Int

BaseURL

Fields
  1. id - Int!
  2. title - String
  3. url - String!
  4. counter - Int!
  5. tags - [Tag]!
  6. publicReady - Boolean!
  7. hash - String!
  8. data - BaseURLData!
  9. createdOn - Time!
  10. updatedOn - Time!

BaseURLData

Fields
  1. meta - HTMLMeta

BillingSettings

Fields
  1. status - OrgBillingStatus!

BookmarkCursor

Fields
  1. result - [OrgLink]!
  2. title - String!
  3. description - String!
  4. url - String!
  5. count - Int!
  6. tagCloud - [Tag]

Boolean

The Boolean scalar type represents true or false.

CloudOrderType

Enum Values
  1. COUNT_ASC
  2. COUNT_DESC
  3. NAME_ASC
  4. NAME_DESC

CloudType

Enum Values
  1. LINKS
  2. ORGANIZATION

CompleteRegisterInput

Fields
  1. name - String!
  2. username - String!
  3. password - String!
  4. key - String!

Cursor

DeletePayload

Fields
  1. success - Boolean!
  2. objectId - ID!
  3. message - String

Domain

Fields
  1. id - Int!
  2. name - String!
  3. lookupName - String!
  4. orgId - NullInt!
  5. orgSlug - NullString!
  6. service - DomainService!
  7. level - DomainLevel!
  8. status - DomainStatus!
  9. isActive - Boolean!
  10. createdOn - Time!
  11. updatedOn - Time!

DomainCursor

Fields
  1. result - [Domain]!
  2. pageInfo - PageInfo

DomainInput

Fields
  1. name - String!
  2. lookupName - String!
  3. orgSlug - String!
  4. service - DomainService!
  5. migrateLinks - Boolean

DomainLevel

Enum Values
  1. SYSTEM
  2. USER

DomainService

Enum Values
  1. LINKS
  2. SHORT
  3. LIST

DomainStatus

Enum Values
  1. PENDING
  2. APPROVED
  3. ERROR

Float

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

FollowPayload

Fields
  1. success - Boolean!
  2. message - String!

GetAdminDomainInput

Fields
  1. limit - Int
  2. after - Cursor
  3. before - Cursor
  4. search - String
  5. filterLevel - DomainLevel
  6. filterService - DomainService
  7. filterActive - Boolean
  8. orgSlug - String

GetAdminOrganizationsInput

Fields
  1. limit - Int
  2. after - Cursor
  3. before - Cursor
  4. search - String
  5. ownerId - Int

GetFeedInput

Fields
  1. limit - Int
  2. after - Cursor
  3. before - Cursor
  4. tag - String
  5. excludeTag - String
  6. search - String
  7. tagCloudType - CloudType
  8. tagCloudOrder - CloudOrderType

GetLinkInput

Fields
  1. orgSlug - String
  2. limit - Int
  3. after - Cursor
  4. before - Cursor
  5. tag - String
  6. excludeTag - String
  7. search - String
  8. filter - String
  9. tagCloudType - CloudType
  10. tagCloudOrder - CloudOrderType

GetLinkShortInput

Fields
  1. orgSlug - String!
  2. limit - Int
  3. after - Cursor
  4. before - Cursor
  5. tag - String
  6. excludeTag - String

GetListingDetailInput

Fields
  1. domainId - Int!
  2. slug - String
  3. limit - Int
  4. after - Cursor
  5. before - Cursor

GetListingInput

Fields
  1. orgSlug - String!
  2. limit - Int
  3. after - Cursor
  4. before - Cursor
  5. tag - String
  6. excludeTag - String

GetOrganizationsInput

Fields
  1. limit - Int
  2. after - Cursor
  3. before - Cursor
  4. search - String

GetPaymentInput

Fields
  1. orgSlug - String
  2. limit - Int
  3. after - Cursor
  4. before - Cursor
  5. interval - Int
  6. dateStart - String
  7. dateEnd - String
  8. filter - Boolean

GetUserInput

Fields
  1. limit - Int
  2. after - Cursor
  3. before - Cursor
  4. search - String

HTMLMeta

Fields
  1. title - String!
  2. description - String!
  3. image - String!
  4. siteName - String!

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.

LinkInput

Fields
  1. url - String!
  2. description - String
  3. visibility - LinkVisibility
  4. unread - Boolean!
  5. starred - Boolean!
  6. archive - Boolean!
  7. orgSlug - String!
  8. title - String!
  9. tags - String
  10. override - Boolean
  11. parseBaseUrl - Boolean

LinkShort

Fields
  1. id - Int!
  2. title - String
  3. url - String!
  4. shortCode - String!
  5. tags - [Tag]!
  6. userId - Int!
  7. domainId - Int
  8. orgId - Int!
  9. lookupName - String!
  10. createdOn - Time!
  11. updatedOn - Time!

LinkShortCursor

Fields
  1. result - [LinkShort]!
  2. pageInfo - PageInfo

LinkShortInput

Fields
  1. url - String!
  2. title - String
  3. shortCode - String
  4. domainId - Int!
  5. orgSlug - String!
  6. tags - String

LinkType

Enum Values
  1. LINK
  2. NOTE

LinkVisibility

Enum Values
  1. PUBLIC
  2. PRIVATE
  3. RESTRICTED

Listing

Fields
  1. id - Int!
  2. title - String!
  3. slug - String!
  4. image - String!
  5. metadata - Metadata!
  6. isActive - Boolean!
  7. isDefault - Boolean!
  8. tags - [Tag]!
  9. userId - Int!
  10. orgId - Int!
  11. domainId - Int!
  12. lookupName - String!
  13. createdOn - Time!
  14. updatedOn - Time!

ListingCursor

Fields
  1. result - [Listing]!
  2. pageInfo - PageInfo

ListingLinkCursor

Fields
  1. result - Listing!
  2. links - [ListingLink]!
  3. pageInfo - PageInfo

Map

MemberInput

Fields
  1. orgSlug - String!
  2. email - String!
  3. permission - MemberPermission!

MemberPermission

Enum Values
  1. READ
  2. WRITE
  3. ADMIN_WRITE

Metadata

Fields
  1. socialLinks - SocialLinks!

NoteInput

Fields
  1. title - String!
  2. description - String!
  3. visibility - LinkVisibility!
  4. tags - String
  5. starred - Boolean!
  6. orgSlug - String!

NullInt

Fields
  1. int64 - Int!
  2. valid - Boolean!

NullString

Fields
  1. string - String!
  2. valid - Boolean!

OrgBillingStatus

Enum Values
  1. FREE
  2. PERSONAL
  3. BUSINESS
  4. OPEN_SOURCE
  5. SPONSORED

OrgLinkCursor

Fields
  1. result - [OrgLink]!
  2. pageInfo - PageInfo
  3. restrictedCount - Int
  4. tagCloud - [Tag]

OrgType

Enum Values
  1. USER
  2. NORMAL

Organization

Fields
  1. id - Int!
  2. ownerId - Int!
  3. orgType - OrgType!
  4. name - String!
  5. slug - String!
  6. image - Upload
  7. timezone - String!
  8. settings - OrganizationSettings!
  9. isActive - Boolean!
  10. createdOn - Time!
  11. updatedOn - Time!
  12. ownerName - String!

OrganizationCursor

Fields
  1. result - [Organization]!
  2. pageInfo - PageInfo

OrganizationInput

Fields
  1. name - String!
  2. orgUsername - String!
  3. image - Upload

OrganizationSettings

Fields
  1. defaultPerm - LinkVisibility!
  2. billing - BillingSettings

OrganizationStats

Fields
  1. links - Int!
  2. lists - Int!
  3. shorts - Int!

PageInfo

This is used in various cursor objects for pagination

Fields
  1. cursor - Cursor!
  2. hasNextPage - Boolean!
  3. hasPrevPage - Boolean!

Payment

Fields
  1. id - Int!
  2. amount - Int!
  3. amountRefunded - Int!
  4. hostedInvoiceURL - String!
  5. createdOn - Time!
  6. amountPaid - Int!
  7. amountNet - Int!
  8. paymentFee - Int!
  9. orgId - Int!
  10. orgSlug - String!

PaymentCursor

Fields
  1. result - [Payment]!
  2. pageInfo - PageInfo

PopularLinkCursor

Fields
  1. result - [BaseURL]!
  2. tagCloud - [Tag]

PopularLinksInput

Fields
  1. tag - String
  2. search - String
  3. limit - Int
  4. tagCloudOrder - CloudOrderType

ProfileInput

Fields
  1. name - String!
  2. defaultLang - String!
  3. timezone - String!
  4. image - Upload
  5. deleteImg - Boolean

QRCode

Fields
  1. id - Int!
  2. title - String!
  3. orgId - Int!
  4. codeType - QRCodeType!
  5. url - String!
  6. imagePath - String!
  7. hashId - String!
  8. createdOn - Time!
  9. clicks - Int!

QRCodeType

Enum Values
  1. LIST
  2. SHORT

QRObject

Fields
  1. qrCodeId - Int!
  2. qrHashId - String!
  3. userId - Int!
  4. createdOn - Time!
  5. title - String!

RegisterInput

Fields
  1. name - String!
  2. password - String!
  3. email - String!
  4. username - String!
  5. key - String

RegisterInvitation

Fields
  1. email - String!

String

The Stringscalar 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.

Tag

Fields
  1. id - Int!
  2. name - String!
  3. slug - String!
  4. createdOn - Time!
  5. count - Int

Time

UpdateAdminDomainInput

Fields
  1. id - Int!
  2. name - String!
  3. lookupName - String!
  4. orgSlug - String
  5. service - DomainService!
  6. level - DomainLevel!
  7. status - DomainStatus!
  8. isActive - Boolean!
  9. migrateLinks - Boolean

UpdateLinkInput

Fields
  1. hash - String!
  2. title - String
  3. description - String
  4. url - String
  5. visibility - LinkVisibility
  6. unread - Boolean
  7. starred - Boolean
  8. tags - String

UpdateLinkShortInput

Fields
  1. id - Int!
  2. title - String
  3. url - String
  4. domainId - Int
  5. shortCode - String
  6. tags - String

UpdateListingInput

Fields
  1. id - Int!
  2. title - String!
  3. slug - String!
  4. image - Upload
  5. deleteImg - Boolean
  6. domainId - Int!
  7. isDefault - Boolean!
  8. isActive - Boolean
  9. tags - String
  10. fediverse - String
  11. bluesky - String
  12. facebook - String
  13. twitter - String
  14. tiktok - String
  15. youtube - String
  16. instagram - String

UpdateListingLinkInput

Fields
  1. id - Int!
  2. title - String!
  3. linkOrder - Int!
  4. url - String!
  5. description - String

UpdateOrganizationInput

Fields
  1. currentSlug - String!
  2. name - String!
  3. slug - String!
  4. image - Upload
  5. isActive - Boolean
  6. deleteImg - Boolean
  7. defaultPerm - LinkVisibility

UpdateUserInput

Fields
  1. id - Int!
  2. email - String!
  3. name - String!
  4. isVerified - Boolean!

Upload

User

Fields
  1. id - Int!
  2. name - String!
  3. email - String!
  4. createdOn - Time!
  5. isEmailVerified - Boolean!
  6. isLocked - Boolean!
  7. lockReason - String!

UserCursor

Fields
  1. result - [User]!
  2. pageInfo - PageInfo

Version

Fields
  1. major - Int!
  2. minor - Int!
  3. patch - Int!
  4. deprecationDate - Time
    • If this API version is scheduled for deprecation, this is the date on which it will stop working; or null if this API version is not scheduled for deprecation.

Directives

@access

Decorates fields for which access requires a particular OAuth 2.0 scope with read or write access.

Arguments
  1. scope - AccessScope!
  2. kind - AccessKind!

@admin

This is used to decorate fields which are only accessible by superuser.

@defer

Directs the executor to defer this fragment when the if argument is true or undefined.

Arguments
  1. if - Boolean
    • Deferred when true or undefined.
  2. label - String
    • Unique name

@deprecated

Marks an element of a GraphQL schema as no longer supported.

Arguments
  1. reason - String
    • Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).

@include

Directs the executor to include this field or fragment only when the if argument is true.

Arguments
  1. if - Boolean!
    • Included when true.

@internal

This used to decorate fields which are for internal use, and are not available to normal API users.

@oneOf

Indicates exactly one field must be supplied and this field must not be null.

@private

This is used to decorate fields which are only accessible with a personal access token, and are not available to clients using OAuth 2.0 access tokens.

@scopehelp

Used to provide a human-friendly description of an access scope.

Arguments
  1. details - String!

@skip

Directs the executor to skip this field or fragment when the if argument is true.

Arguments
  1. if - Boolean!
    • Skipped when true.

@specifiedBy

Exposes a URL that specifies the behavior of this scalar.

Arguments
  1. url - String!
    • The URL that specifies the behavior of this scalar.