---
descriptions:
  list_invitations:
    data: >-
      Array of [invitations](/reference/authkit/invitation) ordered by creation
      time.
reference:
  curl:
    - key: list_invitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: /user_management/invitations
      type: GET
      parameters:
        - key: email
          optional: true
          type: string
          description: (invitation.email)
        - key: organization_id
          optional: true
          type: string
          description: (invitation.organization_id)
        - (limit)
        - (before)
        - (after)
        - (order)
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: data
              type: array
              description: (list_invitations.data)
            - key: list_metadata
              type: object
              properties:
                - (before)
                - (after)
  js:
    - key: listInvitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: userManagement.listInvitations()
      parameters:
        - key: email
          optional: true
          type: string
          description: (invitation.email)
        - key: organizationId
          optional: true
          type: string
          description: (invitation.organization_id)
        - (limit)
        - (before)
        - (after)
        - (order)
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: data
              type: array
              description: (list_invitations.data)
            - key: list_metadata
              type: object
              properties:
                - (before)
                - (after)
  go:
    - key: ListInvitations
      patternBefore: usermanagement.
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: usermanagement.ListInvitations()
      parameters:
        - (ctx)
        - key: opts
          type: usermanagement.ListInvitationsOpts
          unwrap: true
          properties:
            - key: Email
              optional: true
              type: string
              description: (invitation.email)
            - key: OrganizationID
              optional: true
              type: string
              description: (invitation.organization_id)
            - (Limit)
            - (Before)
            - (After)
            - (Order)
      returns:
        - key: invitations
          type: ListInvitationsResponse
          unwrap: true
          properties:
            - key: Data
              type: 'Invitation[]'
              description: (list_invitations.data)
            - key: ListMetadata
              type: ListMetadata
              properties:
                - (Before)
                - (After)
        - (err)
  php:
    - key: listInvitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: $userManagement->listInvitations()
      type: GET
      parameters:
        - key: email
          optional: true
          type: string
          description: (invitation.email)
        - key: organizationId
          optional: true
          type: string
          description: (invitation.organization_id)
        - (limit)
        - (before)
        - (after)
        - (order)
      returns:
        - key: anonymous
          type: array
          unwrap: true
          properties:
            - (before)
            - (after)
            - key: data
              type: 'Invitation[]'
              description: (list_invitations.data)
  python:
    - key: list_invitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: user_management.list_invitations()
      parameters:
        - key: email
          optional: true
          type: str
          description: (invitation.email)
        - key: organization_id
          optional: true
          type: str
          description: (invitation.organization_id)
        - (limit)
        - (before)
        - (after)
        - (order)
      returns:
        - key: anonymous
          type: WorkOSListResource
          unwrap: true
          properties:
            - key: data
              type: 'list[Invitation]'
              description: (list_invitations.data)
            - key: list_metadata
              type: ListMetadata
              properties:
                - (before)
                - (after)
  ruby:
    - key: list_invitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: UserManagement.list_invitations()
      parameters:
        - key: email
          optional: true
          type: String
          description: (list_users.email)
        - key: organization_id
          optional: true
          type: String
          description: (list_users.organization_id)
        - (after)
        - (before)
        - (limit)
        - (order)
      returns:
        - key: anonymous
          type: Struct
          unwrap: true
          properties:
            - key: data
              type: 'Array[Invitation]'
              description: (list_invitations.data)
            - key: list_metadata
              type: Hash
              properties:
                - (before)
                - (after)
  java:
    - key: listInvitations
      id: list_invitations
      url: /reference/authkit/invitation/list
      title: userManagement.listInvitations()
      parameters:
        - key: options
          type: ListInvitationsOptions
          optional: true
          unwrap: true
          properties:
            - key: email
              optional: true
              type: String
              description: (list_users.email)
            - key: organizationId
              optional: true
              type: String
              description: (list_users.organization_id)
            - (after)
            - (before)
            - (limit)
            - (order)
      returns:
        - key: Invitations
          type: Invitations
          unwrap: true
          properties:
            - key: data
              type: 'Array[Invitation]'
              description: (list_invitations.data)
            - key: listMetadata
              type: ListMetadata
              properties:
                - (before)
                - (after)
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/invitation/list.mdx
---

## List invitations

Get a list of all of invitations matching the criteria specified.

<CodeBlock referenceId="list_invitations">
  <CodeBlockTab title="Request" file="list-invitations-request" />
  <CodeBlockTab title="Response" file="list-invitations-response" />
</CodeBlock>