Members

Invite people to an organization by email

post/v1/organizations/{organization_slug}/members

Request

  • Base URL: https://api.heyapi.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.heyapi.dev/v1/organizations/{organization_slug}/members
  • Auth: HTTP bearer

Path parameters

organization_slugstring required
Example:hey-api

Request body

emailsstring[] required

Example request

{
  "emails": [
    "lubos@heyapi.dev",
    "una@heyapi.dev"
  ]
}

Response

OK

Example response

{
  "users": [
    {
      "clerk_user_id": "user_2tDpMYgevIkZOL76Wo6VzXxsbxD",
      "created_at": "2025-02-21T02:37:15.840Z",
      "email": "lubos@heyapi.dev",
      "first_name": "Lubos",
      "id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
      "image_url": "https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvdXBsb2FkZWQvaW1nXzJ0RzFucjNDbzg2azhDTWNoUlBxTHViVEdtTiJ9",
      "last_name": "Menus",
      "roles": [
        {
          "created_at": "2025-02-21T02:37:15.840Z",
          "id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
          "organization_id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
          "status": "active",
          "updated_at": "2025-02-21T02:37:15.840Z",
          "user_id": "5d2827a4-b3fc-4946-bb3b-72f23e89c6aa"
        }
      ],
      "updated_at": "2025-02-21T02:37:15.840Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.