Skip to content

Organization

An organization owns every phone, message, contact and key. API keys can read the organization profile; renaming it and managing the team need a signed-in user, usually in the portal (Team, Settings).

GET/v1/org

Any API key or user of the organization can call it; no scope is needed.

Terminal window
curl https://api.smsfabric.com/v1/org \
-H "X-Api-Key: $SMSFABRIC_API_KEY"
{
"id": "org_n5q8t1w4z7c0f3i6l9o2r5u8",
"name": "Acme Retail",
"slug": "acme-retail",
"status": "active",
"plan": "free",
"createdAt": "2026-09-01T08:00:00.000Z"
}

status is active or suspended.

PATCH/v1/orgsettings:manageuser token only
Body field Type Required Constraints
name string No 1 to 120 characters.
Terminal window
curl -X PATCH https://api.smsfabric.com/v1/org \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "Acme Retail Egypt"}'

Returns the organization. Audited as org.updated.

GET/v1/org/membersuser token only

Every member in one page.

Terminal window
curl https://api.smsfabric.com/v1/org/members \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN"
{
"data": [
{ "userId": "usr_o9r2u5x8a1d4g7j0m3p6s9v2", "name": "Mona Hassan", "email": "mona@acme.example", "role": "owner", "joinedAt": "2026-09-01T08:00:00.000Z" },
{ "userId": "usr_p0s3v6y9b2e5h8k1n4q7t0w3", "name": "Omar Saleh", "email": "omar@acme.example", "role": "developer", "joinedAt": "2026-10-11T12:30:00.000Z" }
],
"nextCursor": null
}
PATCH/v1/org/members/:userIdmembers:manageuser token only
Body field Type Required Constraints
role string Yes owner, admin, developer, campaign_manager, agent, viewer or billing.
Terminal window
curl -X PATCH https://api.smsfabric.com/v1/org/members/usr_p0s3v6y9b2e5h8k1n4q7t0w3 \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"role": "admin"}'

Returns the member. Audited. 409 last_owner if this would leave the organization without an owner.

DELETE/v1/org/members/:userIdmembers:manageuser token only

Returns 204. Audited. 409 last_owner for the only owner.

Terminal window
curl -X DELETE https://api.smsfabric.com/v1/org/members/usr_p0s3v6y9b2e5h8k1n4q7t0w3 \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN"
POST/v1/org/invitationsmembers:manageuser token only

Emails an invitation link. Returns 201. Supports Idempotency-Key. Audited as member.invited.

Body field Type Required Constraints
email string Yes A valid email.
role string Yes One of the roles above.
Terminal window
curl https://api.smsfabric.com/v1/org/invitations \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"email": "sara@acme.example", "role": "campaign_manager"}'
{
"id": "inv_q1t4w7z0c3f6i9l2o5r8u1x4",
"email": "sara@acme.example",
"role": "campaign_manager",
"expiresAt": "2026-11-26T13:30:00.000Z",
"acceptedAt": null,
"createdAt": "2026-11-19T13:30:00.000Z"
}

409 already_member if the person is already in the organization.

GET/v1/org/invitationsmembers:manageuser token only

Every invitation in one page.

Terminal window
curl https://api.smsfabric.com/v1/org/invitations \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN"
DELETE/v1/org/invitations/:idmembers:manageuser token only

The link stops working. Returns 204. Audited as member.invitation_revoked.

Terminal window
curl -X DELETE https://api.smsfabric.com/v1/org/invitations/inv_q1t4w7z0c3f6i9l2o5r8u1x4 \
-H "Authorization: Bearer $SMSFABRIC_USER_TOKEN"