REST API for checking if a specific user is a sponsor and how much they are sponsoring

[catgirlinspace]

Select Topic Area

Product Feedback

Body

hiya! On my web app I want to give sponsors a little icon. Currently GitHub Sponsors only offers a webhook for this, which works, but it doesn't have an easy way of checking if a user is a sponsor for cases where maybe the server received the webhook but was unable to save the new data. I want to have a little refresh button in my web app's settings that when clicked uses some GitHub provided REST API to check if that specific user is sponsoring and for how much, but at the moment it doesn't seem like there's an API for this.

[octokatherine]

Hi @catgirlinspace! I'm an engineer on the Sponsors team. The data you're looking for is available through GitHub's GraphQL API: https://docs.github.com/en/graphql/reference/objects#sponsorship

[catgirlinspace]

hi! I did see this while looking but wasn't sure how to use it exactly. I'm not experienced in using GraphQL APIs at all and wasn't sure how/if I could query by just a specific user id to check if they were sponsoring me. I think I'd have to query each page and then iterate over that to find the specific user I'm looking for?

[octokatherine]

The easiest way to find out if a user is sponsoring you would be to use the isSponsoredBy field on a User. For example:

query {
  viewer {
      isSponsoredBy(accountLogin: "octokatherine")
  }
}

this would tell you whether I am sponsoring you. You can test it out on the GraphQL Explorer

[catgirlinspace]

Ah, didn't know I could do that, thanks!! Is there a way to also get back how much they're sponsoring for or the tier?

[octokatherine]

Yep! You could do something like this

query {
  user(login:"octokatherine") {
    sponsorshipForViewerAsSponsorable(activeOnly:true) {
    	tier {
        name
        monthlyPriceInDollars
      }  
    }
  }
}

replacing my login with the sponsor's login

[catgirlinspace]

Huh, didn't know GraphQL could do that! This looks like exactly what I need, thanks so much!!!!

[QROkes]

Hi @octokatherine I know this is an "old" thread. Can I ask you one question?

Considering sponsorshipForViewerAsSponsorable(activeOnly:true), one-time donors are considered as active? For how long?

Thanks in advance!

[octokatherine]

Hi @QROkes! One time sponsors are active for 30 days.

[honzajavorek]

The query, copy-pasted as is and login replaced, gives me only

{
  "data": {
    "user": {
      "sponsorshipForViewerAsSponsorable": null
    }
  }
}

Not sure what's wrong or if the API has changed 🤔