> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve member > Retrieves the details of an existing member. Required permissions: - `member:basic:read` - `member:email:read` - `member:phone:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /members/{id} openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /members/{id}: get: tags: - Members summary: Retrieve member description: |- Retrieves the details of an existing member. Required permissions: - `member:basic:read` - `member:email:read` - `member:phone:read` operationId: retrieveMember parameters: - name: id in: path required: true description: The unique identifier of the member to retrieve. schema: type: string responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/Member' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - member:basic:read - member:email:read - member:phone:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const member = await client.members.retrieve('id'); console.log(member.id); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) member = client.members.retrieve( "id", ) print(member.id) - lang: Ruby source: |- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") member = whop.members.retrieve("id") puts(member) components: schemas: Member: type: object properties: id: type: string description: The unique identifier for the company member. created_at: type: string format: date-time description: The datetime the company member was created. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: The datetime the company member was last updated. example: '2023-12-01T05:00:00.401Z' joined_at: type: string format: date-time description: When the member joined the company example: '2023-12-01T05:00:00.401Z' access_level: $ref: '#/components/schemas/AccessLevel' description: >- The access level of the product member. If its admin, the member is an authorized user of the company. If its customer, the member has a valid membership to any product on the company. If its no_access, the member does not have access to the product. status: $ref: '#/components/schemas/MemberStatuses' description: The status of the member most_recent_action: oneOf: - $ref: '#/components/schemas/MemberMostRecentActions' - type: 'null' description: The most recent action the member has taken. most_recent_action_at: type: - string - 'null' format: date-time description: The time for the most recent action, if applicable. example: '2023-12-01T05:00:00.401Z' user: type: - object - 'null' properties: id: type: string description: The unique identifier for the company member user. email: type: - string - 'null' description: The digital mailing address of the user. name: type: - string - 'null' description: The user's full name. username: type: string description: The whop username. required: - id - email - name - username description: The user for this member, if any. phone: type: - string - 'null' description: The phone number for the member, if available. usd_total_spent: type: number description: >- How much money this customer has spent on the company's products and plans example: 6.9 company_token_balance: type: number description: The member's token balance for this company example: 6.9 company: type: object properties: id: type: string description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx title: type: string description: The written name of the company. route: type: string description: The slug/route of the company on the Whop site. required: - id - title - route description: The company for the member. required: - id - created_at - updated_at - joined_at - access_level - status - most_recent_action - most_recent_action_at - user - phone - usd_total_spent - company_token_balance - company description: >- A member represents a user's relationship with a company on Whop, including their access level, status, and spending history. AccessLevel: type: string enum: - no_access - admin - customer description: The access level a given user (or company) has to a product or company. MemberStatuses: type: string enum: - drafted - joined - left description: The different statuses a Member can have. MemberMostRecentActions: type: string enum: - canceling - churned - finished_split_pay - paused - paid_subscriber - paid_once - expiring - joined - drafted - left - trialing - pending_entry - renewing - past_due description: The different most recent actions a member can have. securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````