fp2 documentation

curl -X POST https://new.fp.dev/api/v1/workspaces/organizationId/invitations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "email": "string",
  "role": "owner"
}'

{
  "organization_id": "string",
  "name": "string",
  "slug": "string",
  "role": "string",
  "members": [
    {
      "member_id": "string",
      "kind": "user",
      "id": "string",
      "name": "string",
      "email": "string",
      "role": "string",
      "joined_at": "string",
      "handle": "string",
      "sponsor": "present"
    }
  ],
  "members_total": "NaN",
  "invitations": [
    {
      "invitation_id": "string",
      "email": "string",
      "role": "string",
      "status": "pending",
      "expires_at": "string",
      "invited_by": "string",
      "created_at": "string"
    }
  ],
  "actions": [
    {
      "name": "string",
      "title": "string",
      "method": "POST",
      "href": "string",
      "effect": "safe",
      "reversible": true,
      "fields": [
        {
          "kind": "constant",
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "blocked": [
    {
      "name": "string",
      "reason_code": "illegal_edge",
      "message": "string"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "string"
    }
  ]
}

Invites one address to the organization as owner or member. Owners only. An invitation is a pending grant rather than a credential: nothing in the email logs anybody in, and membership arrives when that address completes a verified sign-in. Idempotent by organization and email — re-inviting a pending address refreshes the same grant — so there is no client_id. A person belongs to one organization, so an address that already belongs somewhere is refused with the organization named.

Authentication

AuthorizationBearer

Pass an attributable fp2 API key as Authorization: Bearer <key>. Never embed keys in repositories or documentation.

Path parameters

organizationIdstringRequired

Request

This endpoint expects an object.

emailstringRequiredformat: "^[^\s@]+@[^\s@]+\.[^\s@]+$"<=254 characters

roleenumRequired

Allowed values:

Response

Success

organization_idstring

namestring

slugstring or null

rolestring

memberslist of objects

members_totaldouble or enum or enum

invitationslist of objects

actionslist of objects

blockedlist of objects

linkslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error