GET /profile/get/{username}

Get the card/profile by username.

Headers

  • Accept string Required

    The format to return errors in (if applicable) and, for some endpoints, the format to return the data in. In general, we recommend having it set to application/json

    Values are application/json, text/calendar, text/plain, or text/html. Default value is application/json.

Path parameters

  • username string Required

    The username of the user whose pronouns are to be retrieved.

Responses

  • 200 application/json

    Example User Data

    Hide response attributes Show response attributes object
    • username string Required

      The user's username

    • id string Required

      A unique identifier for an item, typically a 26-character alphanumeric string.

    • avatarSource string Required

      The source of the user's profile picture

      Values are gravatar, discord, google, twitter, mastodon, indie, or custom.

    • bannedReason string | null

      The reason that the user was banned for (if available)

    • bannedTerms array[string]

      The specific sections of the ToS in which the user violated

    • bannedBy string

      A unique identifier for an item, typically a 26-character alphanumeric string.

    • team boolean Required

      Whether or not the user is a team member

    • personally string | null Required
    • emailHash string Required

      The hash of the user's email address (MD5 if old, SHA1 if new)

    • avatar string Required

      The link to the user's avatar

    • profiles array[object] Required

      The profiles that the user has

      Hide profiles attributes Show profiles attributes object
      • locale string

        The locale of which the profile is for

      • id string Required

        A unique identifier for an item, typically a 26-character alphanumeric string.

      • opinions array[object]

        The custom opinions that the profile declares

        Hide opinions attributes Show opinions attributes object
        • icon string Required

          The icon used on this opinion. This is also used as the identifier whenever an option is specified in an object

        • description string Required

          A short description of the opinion being expressed

        • colour string Required

          The colour associated with this opinion, used for display purposes

        • style string Required

          The style associated with this opinion, used for display purposes

      • names array[object] Required

        The names that the profile declares

        Hide names attributes Show names attributes object
        • pronunciation string | null Required

          The pronunciation of the name, if applicable

        • voice string | null Required

          The voice associated with this name, used for display purposes

        • value string Required

          The name itself

        • opinion string Required

          The opinion associated with this name, used for display purposes

      • pronouns array[object] Required

        The pronouns that the profile declares

        Hide pronouns attributes Show pronouns attributes object
        • value string Required

          The pronoun itself

        • opinion string Required

          The opinion associated with this pronoun, used for display purposes

      • description string | null Required

        The profile's description/about me section

      • age integer | null Required

        The profile owner's age

      • links array[string] Required

        The links that the profile declares

      • linksMetadata array[object] Required

        Link Metadata information

        Hide linksMetadata attributes Show linksMetadata attributes object
        • link string Required

          The link itself

        • favicon string Required

          The link to the website's favicon (website icon)

        • relMe array[string | null] Required

          The links used to identify whether or not there is a <... rel="me"> HTML property linking to this URL, used for verifying ownership of the link

        • nodeinfo object | null Required

          Information for the node

      • verifiedLinks array[object] Required
      • flags array[string] Required

        The flags that the user has

      • customFlags array[string | null] Required

        Custom flags that the user provides

      • words array[object] Required

        The words that the profile declares

        Hide words attributes Show words attributes object
        • header string Required
        • words array[object] Required
          Hide words attributes Show words attributes object
          • value string Required

            The word itself

          • opinion string Required

            The opinion associated with the word, used for display purposes

      • birthday string(date) | null Required

        The birthday of the user

      • timezone object Required
        Hide timezone attributes Show timezone attributes object
        • tz string

          The IANA timezone identifier

        • area boolean

          Whether or not to declare the course area provided in the timezone

        • loc boolean

          Whether or not to declare the specific location provided in the timezone

      • teamName string | null Required

        The name used to identify them in the team page (if applicable)

      • footerName string | null Required

        The name used to identify them in the footer (if applicable)

      • footerAreas array[string] Required

        The areas in which the user helped in as shown in the footer (if applicable)

      • credentials array[string | null] Required

        The user's credentials information

      • credentialsLevel string | null Required
      • credentialsName string | null Required
      • card string | null Required

        The link to the user's profile card image (if applicable)

      • cardDark string | null Required

        The link to the user's dark mode profile card image (if applicable)

      • circle array[object] Required

        The user's declared circle

        Hide circle attributes Show circle attributes object
        • username string Required

          The username of the user in the circle

        • avatar string Required

          The avatar of the user in the circle

        • circleMutual boolean Required

          Whether or not the user in the circle is also in the profile owner's circle

        • locale string Required

          The locale in which the user is in the circle

        • relationship string Required

          A short description of the relationship

      • sensitive array[string | null] Required

        The sensitive topics declared by the user

      • events array[string] Required

        The events that the user added to their profile

      • customEvents array[object] Required

        The custom events that the user added to their profile

        Hide customEvents attributes Show customEvents attributes object
        • icon string Required

          The icon associated with the event, used for display purposes

        • name string Required

          The name of the event

        • month integer Required

          The month the event occurs on

        • day integer Required

          The day the event occurs on

        • comment string Required

          A short comment about the event

      • visibility integer Required

        The visibility that the user allows (0 = Internal, 1 = Bots/Scrapers, 2 = Everyone)

        Values are 0, 1, or 2.

      • access boolean Required

        Whether or not the profile is accessible to the requestee

      • lastUpdate string Required

        The ID identifing when the profile was last updated at
  • default application/json

    Basic Error Response

    Hide response attributes Show response attributes object
    • statusCode number Required

      The HTTP Status Code associated with the error

    • error boolean Required

      Indicates that the response is an error

      Value is true.

    • statusMessage string Required

      The message associated with the error

    • message string Required

      The message associated with the error (client visible)

    • url string Required

      The URL that was requested which resulted in the error
GET /profile/get/{username} 
curl \
 --request GET 'https://pronoms.fr/api/public/v3/profile/get/{username}' \
 --header "Accept: application/json"
Response examples (200) 
{
  "id": "01KK2M3YM6KDNR4TZFCMV46J2F",
  "username": "therealbenpai",
  "avatarSource": "gravatar",
  "bannedReason": null,
  "bannedTerms": [],
  "bannedBy": null,
  "team": 1,
  "personally": null,
  "emailHash": "f4353bfc07ad129aef250603da84be63cbe374dc27064a1c45fd9c59934944df",
  "avatar": "https://gravatar.com/avatar/f4353bfc07ad129aef250603da84be63cbe374dc27064a1c45fd9c59934944df?d=https%3A%2F%2Favi.avris.it%2Fshape-240%2FdGhlcmVhbGJlbnBhaQ%3D%3D.png&s=240",
  "profiles": [
    {
      "id": "01KK2M4X582Y1T4038WBBCMWAF",
      "opinions": [
        {
          "icon": "keyboard",
          "description": "Online",
          "colour": "blue",
          "style": "italics"
        }
      ],
      "names": [
        {
          "pronunciation": "/ˈbɛːnʤəmən/",
          "voice": "en-US",
          "value": "Benjamin",
          "opinion": "yes"
        }
      ],
      "pronouns": [
        {
          "value": "https://en.pronouns.page/he&they",
          "opinion": "yes"
        }
      ],
      "description": "Example Description",
      "age": 18,
      "links": [
        "https://cake.avris.it/gA1"
      ],
      "linksMetadata": [
        {
          "favicon": null,
          "relMe": null,
          "nodeinfo": null,
          "url": "https://cake.avris.it/gA1"
        },
        {
          "favicon": null,
          "relMe": null,
          "nodeinfo": null,
          "url": "https://github.com/therealbenpai"
        },
        {
          "favicon": null,
          "relMe": null,
          "nodeinfo": null,
          "url": "https://spectrum.avris.it/aCQB"
        }
      ],
      "verifiedLinks": [],
      "flags": [
        "Demiromantic",
        "Biromantic",
        "Demisexual"
      ],
      "customFlags": [],
      "words": [
        {
          "header": "Honorifics",
          "values": [
            {
              "value": "[no honorific]",
              "opinion": "check-square"
            }
          ]
        },
        {
          "header": "Person and family descriptions",
          "values": [
            {
              "value": "woman",
              "opinion": "no"
            },
            {
              "value": "lady",
              "opinion": "no"
            },
            {
              "value": "dude",
              "opinion": "no"
            },
            {
              "value": "enby",
              "opinion": "no"
            },
            {
              "value": "boy",
              "opinion": "no"
            },
            {
              "value": "girl",
              "opinion": "no"
            }
          ]
        },
        {
          "header": "Compliments",
          "values": [
            {
              "value": "sexy",
              "opinion": "no"
            }
          ]
        },
        {
          "header": "Relationship descriptions",
          "values": [
            {
              "value": "girlfriend",
              "opinion": "no"
            },
            {
              "value": "enbyfriend",
              "opinion": "no"
            },
            {
              "value": "joyfriend",
              "opinion": "no"
            }
          ]
        }
      ],
      "timezone": {
        "tz": "America/Detroit",
        "area": true,
        "loc": false
      },
      "teamName": "Benjamin",
      "footerName": null,
      "footerAreas": [],
      "credentials": [],
      "credentialsLevel": null,
      "credentialsName": null,
      "card": null,
      "cardDark": null,
      "circle": [],
      "sensitive": [],
      "markdown": true,
      "events": [
        "holocaust_remembrance_day",
        "asexuality_day",
        "pride_month",
        "LGBTQ+ History Month (US/Canada/Australia)",
        "trans_month",
        "aids_awareness_month"
      ],
      "customEvents": [],
      "visibility": 0,
      "access": true,
      "lastUpdate": "01KK2MKQKHMQ01G2GNSMXQ1CMG",
      "locale": "en"
    }
  ]
}
Response examples (default)
The request contains invalid content 
{
  "error": true,
  "statusCode": 400,
  "statusMessage": "Bad Request",
  "message": "XYZ contains an invalid value",
  "url": "https://en.pronouns.page/api/v1/nouns/search/01JBXS13H8311MFPJYEXCPFZZJ"
}
The user requesting this data is not authorised to access the requested section 
{
  "error": true,
  "statusCode": 401,
  "statusMessage": "Unauthorised",
  "message": "You are not authorised to access this content",
  "url": "https://en.pronouns.page/api/v1/nouns/search/01JBXS13H8311MFPJYEXCPFZZJ"
}
The requested item could not be resolved/located 
{
  "error": true,
  "statusCode": 404,
  "statusMessage": "Not Found",
  "message": "Requested Item Not Found",
  "url": "https://en.pronouns.page/api/v1/nouns/search/01JBXS13H8311MFPJYEXCPFZZJ"
}
The requested API version has either been completely removed or marked as depreciated 
{
  "error": true,
  "statusCode": 410,
  "statusMessage": "Gone",
  "message": "v1 has been marked as depreciated; please use v2 or v3",
  "url": "https://en.pronouns.page/api/v1/nouns/search/01JBXS13H8311MFPJYEXCPFZZJ"
}
Unknown Server Error 
{
  "error": true,
  "statusCode": 500,
  "statusMessage": "Server Error",
  "message": "An unknown server error has occured, please try again later",
  "url": "https://en.pronouns.page/api/v1/nouns/search/01JBXS13H8311MFPJYEXCPFZZJ"
}