Organizations
Get the current organization
Returns the organization for the current billing account. Use this endpoint to get the current organization through the Samva email API.
GET
Returns the organization for the current billing account.
apiKeyheader
x-api-key<token>Organization
application/json- response
id*stringbillingAccountId*stringname*stringslug*stringavatarUrl*|URL of the organization's avatar image, hosted by Samva. Null when no avatar is set.
defaultRegion*|nulltimezone*stringplan*stringisActive*booleancreatedAt*stringupdatedAt*stringmetadata*|nullreplyToDefault*array<string>|nullemailFooterEnabledDefault*boolean|nullmessagesUsed*numbermessagesUsedThisMonth*numbersmsUsed*numbersmsUsedThisMonth*numberwhatsappUsed*numberwhatsappUsedThisMonth*numberemailUsed*numberemailUsedThisMonth*numbercontactsUsed*numberconversationsUsed*numberteamMembersUsed*numbermessagesResetAt*string|nullimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.organizations.get({});Example Response
{ "id": "string", "billingAccountId": "string", "name": "string", "slug": "string", "avatarUrl": "string", "defaultRegion": "string", "timezone": "string", "plan": "string", "isActive": true, "createdAt": "string", "updatedAt": "string", "metadata": { "property1": "string", "property2": "string" }, "replyToDefault": [ "string" ], "emailFooterEnabledDefault": true, "messagesUsed": 0, "messagesUsedThisMonth": 0, "smsUsed": 0, "smsUsedThisMonth": 0, "whatsappUsed": 0, "whatsappUsedThisMonth": 0, "emailUsed": 0, "emailUsedThisMonth": 0, "contactsUsed": 0, "conversationsUsed": 0, "teamMembersUsed": 0, "messagesResetAt": "string"}