Reference
2
OAS 3.1.0

Patreon API

An unofficial OpenAPI schema for the V2 Patreon API. Made based on the official api with https://github.com/ghostrider-05/patreon-api.ts

API domain

OAuth 2.0 (Oauth2)
Client Libraries
cURL Shell

Resources​

Resources Endpoints

Get identity​

Query Parameters
  • include
    array string[] enum
    • campaign
    • memberships
  • fields
    object
Headers
  • User-Agent
    string
    default: 
    PatreonBot patreon-api.ts (https://github.com/ghostrider-05/patreon-api.ts, 0.9.0)
    required
Responses
GET/api/oauth/v2/identity
curl https://patreon.com/api/oauth/v2/identity \
  --header 'User-Agent: PatreonBot patreon-api.ts (https://github.com/ghostrider-05/patreon-api.ts, 0.9.0)'

{
  "data": {
    "id": "…",
    "type": "user",
    "attributes": {
      "about": null,
      "can_see_nsfw": null,
      "created": "2024-12-09T14:12:04.057Z",
      "email": "hello@example.com",
      "first_name": null,
      "full_name": "…",
      "hide_pledges": null,
      "image_url": "https://example.com",
      "is_creator": true,
      "is_email_verified": true,
      "last_name": null,
      "like_count": 1,
      "social_connections": {},
      "thumb_url": "https://example.com",
      "url": "https://example.com",
      "vanity": null
    },
    "relationships": {
      "campaign": {
        "data": {
          "id": "…",
          "type": "campaign"
        },
        "links": {
          "related": "https://example.com"
        }
      },
      "memberships": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "…",
      "type": "campaign",
      "attributes": {
        "vanity": null,
        "url": "https://example.com",
        "thanks_video_url": null,
        "thanks_msg": null,
        "thanks_embed": null,
        "summary": null,
        "show_earnings": true,
        "rss_feed_title": null,
        "rss_artwork_url": null,
        "published_at": null,
        "pledge_url": "…",
        "pay_per_name": null,
        "patron_count": 1,
        "one_liner": null,
        "main_video_url": null,
        "main_video_embed": null,
        "is_nsfw": true,
        "is_monthly": true,
        "is_charged_immediately": true,
        "image_url": "https://example.com",
        "image_small_url": "https://example.com",
        "has_sent_rss_notify": true,
        "has_rss": true,
        "google_analytics_id": null,
        "discord_server_id": null,
        "creation_name": null,
        "created_at": "2024-12-09T14:12:04.057Z"
      }
    }
  ],
  "links": {
    "self": "…"
  }
}

OK: Completed your request succesfully

Models