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

# Get members

> Retrieve all members with optional pagination



## OpenAPI

````yaml https://api.cevoid.com/v1/openapi.json get /v1/members
openapi: 3.0.0
info:
  version: 1.0.0
  title: Cevoid Public API
  description: >-
    Public API for accessing Cevoid user-generated content and loyalty data. Use
    this API to retrieve posts, members, markets, and other data from your
    Cevoid account.
  contact:
    name: Cevoid Support
    url: https://cevoid.com/support
    email: support@cevoid.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.cevoid.com
    description: Production server
  - url: http://localhost:3001
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: Posts
    description: User-generated content posts operations
  - name: Members
    description: Loyalty program members operations
  - name: Markets
    description: Market and localization operations
paths:
  /v1/members:
    get:
      tags:
        - Members
      summary: Get members
      description: Retrieve all members with optional pagination
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 25
            default: 25
            description: Max value for limit is 25
            example: 10
          required: false
          description: Max value for limit is 25
          name: limit
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
            default: 0
            description: Number of items to skip
            example: 0
          required: false
          description: Number of items to skip
          name: skip
          in: query
        - schema:
            type: string
            description: Market ID or shortId for localized content
            example: us
          required: false
          description: Market ID or shortId for localized content
          name: market
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembersResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    MembersResponse:
      type: object
      properties:
        count:
          type: number
          description: Total number of items
        next:
          type: string
          nullable: true
          description: URL for next page
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/Member'
      required:
        - count
        - next
        - nodes
    ErrorResponse:
      type: string
    UnauthorizedResponse:
      type: string
      enum:
        - No valid API key provided
    InternalServerErrorResponse:
      type: string
      enum:
        - Something went wrong
    Member:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the member within the Cevoid system
          example: member_abc123def456
        shortId:
          type: string
          description: >-
            Shortened, human-readable identifier for the member, often used in
            URLs and public references
          example: mem_5a8b9c
        name:
          type: string
          description: >-
            Display name or full name of the member as provided during
            registration or profile updates
          example: Sarah Johnson
        email:
          type: string
          description: >-
            Email address associated with the member account, used for
            communication and authentication
          example: sarah.johnson@example.com
        avatarUrl:
          type: string
          description: URL to the member's profile picture or avatar image
          example: https://cdn.cevoid.com/avatars/member123/profile.jpg
        country:
          type: string
          description: >-
            ISO 3166-1 alpha-2 country code representing the member's country of
            residence
          example: US
        language:
          type: string
          description: >-
            ISO 639-1 language code representing the member's preferred language
            for communications
          example: en
        location:
          type: string
          description: >-
            Geographic location information such as city, state, or region
            provided by the member
          example: San Francisco, CA
        socialInstagramHandle:
          type: string
          description: >-
            Instagram username/handle associated with the member's social media
            account, without the @ symbol
          example: sarah.lifestyle
        bio:
          type: string
          description: Biography or description provided by the member
          example: Lifestyle blogger and photography enthusiast
        notes:
          type: string
          description: Internal notes about the member for company reference
          example: VIP customer, prefers email communication
        createdAt:
          type: string
          description: >-
            ISO 8601 timestamp indicating when the member account was first
            created in the system
          example: '2024-01-15T09:30:00.000Z'
        updatedAt:
          type: string
          description: ISO 8601 timestamp indicating when the member was last updated
          example: '2024-01-20T14:22:15.000Z'
      required:
        - id
        - shortId
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````