docs: add '/v2/farcaster/user/memberships/list' endpoint (#213)

neynarxyz · Oct 9, 2024 · b699ad5 · b699ad5
1 parent 6a6e0d3
commit b699ad5
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -1901,10 +1901,16 @@ components:
     ChannelMember:
       type: object
       required:
+        - object
         - channel_id
         - role
         - user
+        - channel
       properties:
+        object:
+          type: string
+          enum:
+            - member
         channel_id:
           $ref: "#/components/schemas/ChannelId"
           deprecated: true
@@ -1923,6 +1929,7 @@ components:
       type: object
       required:
         - members
+        - next
       properties:
         members:
           type: array
@@ -4045,6 +4052,50 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ChannelListResponse"
+  /farcaster/user/memberships/list:
+    get:
+      tags:
+        - Channel
+      summary: Retrieve all channels that a given fid is a member of
+      description: Returns a list of all channels with their details that an fid is a member of. Data may have a delay of up to 1 hour.
+      externalDocs:
+        url: https://docs.neynar.com/reference/user-channel-memberships
+      operationId: user-channel-memberships
+      parameters:
+        - $ref: "#/components/parameters/ApiKey"
+        - name: fid
+          in: query
+          required: true
+          description: The fid of the user.
+          example: 3
+          schema:
+            $ref: "#/components/schemas/Fid"
+        - name: limit
+          in: query
+          description: Number of results to retrieve (default 20, max 100)
+          required: false
+          schema:
+            type: integer
+            default: 20
+            minimum: 1
+            maximum: 100
+        - name: cursor
+          in: query
+          description: Pagination cursor.
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ChannelMemberListResponse"
+        "400":
+          $ref: "#/components/responses/400Response"
+        "500":
+          $ref: "#/components/responses/500Response"
   /farcaster/user:
     patch:
       tags: