Skip to main content
GET
/
api
/
public
/
v1
/
user-profiles
/
lookup
Lookup User Profile Jsonapi
curl --request GET \
  --url https://api.example.com/api/public/v1/user-profiles/lookup \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "attributes": {
      "platform": "<string>",
      "platform_user_id": "<string>",
      "display_name": "<string>"
    },
    "type": "user-profiles"
  },
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "self_": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next_": "<string>",
    "describedby": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string | null

Query Parameters

​
platform
string
default:discord

Platform type (discord, discourse, github, email)

​
platform_user_id
string
required

Platform-specific user ID (e.g., Discord user ID, Discourse user ID)

​
provider_scope
string
default:*

Provider scope (e.g., Discourse domain). '*' for global.

Response

Successful Response

JSON:API response for user profile lookup.

​
data
UserProfileLookupResource · object
required

JSON:API resource object for user profile lookup response.

​
jsonapi
Jsonapi · object
​
links
JSONAPILinks · object

JSON:API links object for pagination and resource links.

Uses field aliases for 'self' and 'next' which are Python reserved words. Always use by_alias=True when serializing. Includes JSON:API 1.1 'describedby' link for API documentation.