> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beyondwords.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get project members

> Lists project members within a project



## OpenAPI

````yaml get /projects/{project_id}/members
openapi: 3.0.1
info:
  title: BeyondWords REST API
  description: |-
    This is the documentation for the BeyondWords REST API.
              You can use this API to use BeyondWords programmatically.
              You can get your API Key and Project ID for each project in the Project settings tab in the BeyondWords
              <a href="https://dash.beyondwords.io/dashboard">dashboard</a>.
  version: 1.0.0
servers:
  - url: https://api.beyondwords.io/v1
security: []
paths:
  /projects/{project_id}/members:
    parameters:
      - name: project_id
        in: path
        description: The numeric ID of your project
        required: true
        schema:
          type: string
    get:
      tags:
        - Project members
      summary: List
      description: Lists project members within a project
      operationId: projects/members#index
      parameters:
        - name: pagination[limit]
          in: query
          required: false
          description: '''limit'' sets the number of results to return in each page.'
          schema:
            type: integer
        - name: pagination[offset]
          in: query
          required: false
          description: >-
            'offset' sets the first position to return from the results of the
            query. The default is 0, which starts the page at the first result.
          schema:
            type: integer
        - name: filter[name]
          in: query
          required: false
          description: filter by name
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            X-Pagination-Limit:
              description: |-
                The requested number of results to be returned for this request.
                          The actual number of results returned may be lower.
              schema:
                type: integer
              required: false
            X-Pagination-OffSet:
              description: >-
                The position of the first result in the response (before
                pagination was applied).
              schema:
                type: integer
              required: false
            X-Pagination-Total-Count:
              description: >-
                The total number of results returned for this query (before
                pagination was applied).
              schema:
                type: integer
              required: false
            X-BeyondWords-Filter:
              description: The filters fields applied (if any).
              schema:
                type: string
              required: false
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/membersExample'
              schema:
                $ref: '#/components/schemas/membersModel'
        '401':
          description: Invalid authentication token
          content:
            application/json:
              examples:
                example:
                  $ref: '#/components/examples/unauthorizedErrorExample'
              schema:
                $ref: '#/components/schemas/errorModel'
      security:
        - apiKey: []
components:
  examples:
    membersExample:
      summary: A sample members
      value:
        - id: 0
          first_name: James
          last_name: Bond
          email: james@example.com
          role:
            id: 1
            name: Admin
            key: admin
          pending: false
          avatar_url: https://example.com/avatar.jpg
          created: 2019-12-09 22:18:26 UTC
          updated: 2020-01-23 08:55:38 UTC
    unauthorizedErrorExample:
      summary: Unauthorized error
      value:
        code: 401
        message: Unauthorized
  schemas:
    membersModel:
      type: array
      items:
        $ref: '#/components/schemas/memberModel'
    errorModel:
      type: object
      properties:
        code:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
        errors:
          type: array
          nullable: true
          items:
            type: object
            properties:
              location:
                type: string
              message:
                type: string
    memberModel:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the object
        first_name:
          type: string
          description: The member’s first name
        last_name:
          type: string
          description: The member’s last name
          nullable: true
        email:
          type: string
          description: The member's email
        role:
          type: object
          nullable: true
          properties:
            id:
              type: integer
            name:
              type: string
            key:
              type: string
            permissions:
              type: object
        email_confirmed:
          type: boolean
          description: >-
            Whether or not the member has accepted their invitation to the
            organization. Has the value true after the member has validated
            their organization using an email link. The default is false.
        marketing_subscribed:
          type: boolean
          description: Whether the user is subscribed to marketing emails.
        notifications_billing_enabled:
          type: boolean
          nullable: true
          description: Billing notifications.
        avatar_url:
          type: string
          nullable: true
          description: The member's avatar url
        signup_origin:
          type: string
          enum:
            - default
            - google
          description: Origin of sign up. Possible values include `default` or `google`.
        created:
          type: string
          format: date-time
          description: Time at which the object was created (ISO 8601)
        updated:
          type: string
          format: date-time
          description: Time at which the object was updated (ISO 8601)
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````