patreon-api.ts

Appearance

Interface: User ​

Defined in: schemas/v2/resources/user.ts:29

The Patreon user, which can be both patron and creator.

Properties ​

about ​

about: null | string

Defined in: schemas/v2/resources/user.ts:33

The user's about text, which appears on their profile

can_see_nsfw ​

can_see_nsfw: null | boolean

Defined in: schemas/v2/resources/user.ts:38

Whether this user can view nsfw content

created ​

created: string

Defined in: schemas/v2/resources/user.ts:44

Datetime of this user's account creation

Format ​

date-time

email ​

email: string

Defined in: schemas/v2/resources/user.ts:52

The user's email address. Requires certain scopes to access. See the scopes section of the documentation

Format ​

email

first_name ​

first_name: null | string

Defined in: schemas/v2/resources/user.ts:57

First name.

full_name ​

full_name: string

Defined in: schemas/v2/resources/user.ts:62

Combined first and last name

hide_pledges ​

hide_pledges: null | boolean

Defined in: schemas/v2/resources/user.ts:67

Whether the user has chosen to keep private which creators they pledge to

image_url ​

image_url: string

Defined in: schemas/v2/resources/user.ts:73

The user's profile picture URL, scaled to width 400px

Format ​

uri

is_creator ​

is_creator: boolean

Defined in: schemas/v2/resources/user.ts:78

Whether this user has an active campaign.

is_email_verified ​

is_email_verified: boolean

Defined in: schemas/v2/resources/user.ts:83

Whether the user has confirmed their email

last_name ​

last_name: null | string

Defined in: schemas/v2/resources/user.ts:88

Last name.

like_count ​

like_count: number

Defined in: schemas/v2/resources/user.ts:93

How many posts this user has liked

social_connections ​

social_connections: object

Defined in: schemas/v2/resources/user.ts:110

Mapping from user's connected app names to external user id on the respective app

NOTE: since the documentation is object, this can change without notice. For a more accurate representation use the following type using TypeScript module augmentation:

ts
import 'patreon-api.ts'

declare module 'patreon-api.ts' {
   interface CustomTypeOptions {
       social_connections: Record<string, { url: string, user_id: string } | null>
   }
}

thumb_url ​

thumb_url: string

Defined in: schemas/v2/resources/user.ts:116

The user's profile picture URL, scaled to a square of size 100x100px

Format ​

uri

url ​

url: string

Defined in: schemas/v2/resources/user.ts:122

URL of this user's creator or patron profile

Format ​

uri

vanity ​

vanity: null | string

Defined in: schemas/v2/resources/user.ts:130

The public "username" of the user. patreon.com/ goes to this user's creator page. Non-creator users might not have a vanity.

Deprecated ​

use Campaign.vanity