Federation Members

Add and remove member applications from a federation group.

Members are organizations that participate in a federation group. Each member has a unique prefix used to namespace its modules.

Scope: permissions:manage

Rate limit: 500/hr

Add a member

POST /api/v1/permissions/federation/groups/:id/members

Field	Type	Required	Description
`organizationId`	`string`	Yes	The org ID to add
`prefix`	`string`	Yes	2-4 uppercase character prefix, unique within the group

curl -X POST https://api.platformxe.com/api/v1/permissions/federation/groups/fed_abc123/members \
  -H "Content-Type: application/json" \
  -H "x-api-key: pxk_live_your_api_key_here" \
  -d '{
    "organizationId": "org_lettings456",
    "prefix": "LT"
  }'

await px.permissions.addFederationMember('fed_abc123', {
  organizationId: 'org_lettings456',
  prefix: 'LT',
});

Prefix rules

Must be 2-4 uppercase characters (A-Z)
Must be unique within the group
Cannot be changed after creation — remove and re-add to change prefix
Used in federated keys: LT:BOOKINGS:CREATE

Remove a member

DELETE /api/v1/permissions/federation/groups/:id/members/:memberId

curl -X DELETE https://api.platformxe.com/api/v1/permissions/federation/groups/fed_abc123/members/mem_xyz789 \
  -H "x-api-key: pxk_live_your_api_key_here"

await px.permissions.removeFederationMember('fed_abc123', 'mem_xyz789');

You cannot remove the owning organization from its own group. To transfer ownership, delete and recreate the group under a different owner.

Listing members

Members are returned as part of the group detail response:

{
  "success": true,
  "data": {
    "id": "fed_abc123",
    "name": "Caldera Ecosystem",
    "members": [
      { "id": "mem_001", "organizationId": "org_owner456", "prefix": "XA", "isOwner": true },
      { "id": "mem_002", "organizationId": "org_lettings456", "prefix": "LT", "isOwner": false },
      { "id": "mem_003", "organizationId": "org_concierge789", "prefix": "CC", "isOwner": false }
    ]
  }
}

Error responses

Code	Description
`BAD_REQUEST`	Invalid prefix format or prefix already taken
`FORBIDDEN`	Not on Enterprise plan, or not the group owner
`NOT_FOUND`	Group or member does not exist
`CONFLICT`	Organization is already a member of this group