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

# Get your invite link

> Your invite link and how many people you invited signed up. What they unlock: `unlocks` and `unlocks_datasets` below, and [Files](/files).



## OpenAPI

````yaml /openapi.json get /me/invites/
openapi: 3.1.0
info:
  title: Datacircle API
  version: '1'
servers:
  - url: https://api.datacircle.dev
security:
  - token: []
tags:
  - name: Datacircle
    description: >-
      Your Datacircle account: dollar credits, checkout, files, invites, API
      key.
  - name: iBlinked
    description: >-
      LinkedIn Profile API: iBlinked's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: iblinked`.
  - name: Up2Data
    description: >-
      LinkedIn Profile API: Up2Data's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: up2data`.
paths:
  /me/invites/:
    get:
      tags:
        - Datacircle
      summary: Get your invite link
      description: >-
        Your invite link and how many people you invited signed up. What they
        unlock: `unlocks` and `unlocks_datasets` below, and [Files](/files).
      responses:
        '200':
          description: >-
            `{"invite_url": ..., "signed_up_count": 0, "required_count": 3,
            "unlocks": ..., "unlocks_datasets": ["coop_iblinked",
            "coop_up2data", "us_50m"]}`
          content:
            application/json:
              schema:
                type: object
                required:
                  - invite_url
                  - signed_up_count
                  - required_count
                  - unlocks
                  - unlocks_datasets
                properties:
                  invite_url:
                    type: string
                    description: >-
                      Your own signup link: whoever signs up through it is your
                      invitee.
                  signed_up_count:
                    type: integer
                    description: >-
                      How many people you invited have signed up and verified
                      their email. People on your own email domain and
                      deactivated accounts don't count.
                  required_count:
                    type: integer
                    description: >-
                      How many signed-up invitees unlock the files in
                      `unlocks_datasets`.
                  unlocks:
                    type: string
                    description: >-
                      What reaching `required_count` unlocks, in words, and that
                      50 dollar credits bought unlock only the co-op file.
                  unlocks_datasets:
                    type: array
                    items:
                      type: string
                    description: >-
                      The `dataset`s in `GET /files/` that reaching
                      `required_count` unlocks.
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer
      description: >-
        Your API key: `Authorization: Bearer <your API key>`. `Authorization:
        Token <your API key>` works too.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.