Cosmily API documentation

GET /users/:id_or_username

GET /users/{id_or_username}

Get user by ID or username

Path parameters

id_or_username string Required

Username or ID of user

Responses

• 200

successful operation
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes
  
  id integer
  
  auth0_id string
  
  username string
  
  email string
  
  user_type string
  
  followed_by_count integer
  
  following_count integer
  
  supergroups array[string]
  
  last_active string
  
  followed_by_me boolean
  
  profile object
  
  Hide profile attributes Show profile attributes
  
  id integer
  
  user_id integer
  
  full_name string
  
  tagline string
  
  about_me string
  
  instagram_handle string
  
  twitter_handle string
  
  tiktok_handle string
  
  instagram_url string
  
  twitter_url string
  
  tiktok_url string
  
  profile_url string
  
  website string
  
  referrer_id integer
  
  profile_picture object
  
  Hide profile_picture attributes Show profile_picture attributes
  
  id integer
  
  user_id integer
  
  image string
  
  url string
• 400

Bad Request
• 401

Authorization information is missing or invalid.
• 422

Unprocessable Entity
• 500

Server Error

GET /users/{id_or_username}

curl \
 -X GET https://api.cosmily.com/api/v1/users/{id_or_username} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "id": 42,
    "auth0_id": "string",
    "username": "string",
    "email": "string",
    "user_type": "string",
    "followed_by_count": 42,
    "following_count": 42,
    "supergroups": [
      "string"
    ],
    "last_active": "string",
    "followed_by_me": true,
    "profile": {
      "id": 122,
      "user_id": 122,
      "full_name": "Jane Doe",
      "tagline": "Skincare lover from NYC.",
      "about_me": "Native New Yorker Janehn Doe is a NYC & MIAMI based esthetician, known for her microcurrent facials.  Her clients include some of the industry's top editors and models, and she's been featured in Vogue, Elle, Harper’s Bazaar, and countless other publications. ",
      "instagram_handle": "jane_doe122",
      "twitter_handle": "jane_doe122",
      "tiktok_handle": "jane_doe122",
      "instagram_url": "https://instagram.com/jane_doe122",
      "twitter_url": "https://twitter.com/jane_doe122",
      "tiktok_url": "https://instagram.com/jane_doe122",
      "profile_url": "https://cosmily.com/u/jane_doe",
      "website": "https://janedoe.com/",
      "referrer_id": 42
    },
    "profile_picture": {
      "id": 42,
      "user_id": 42,
      "image": "string",
      "url": "string"
    }
  }
}