Skip to content
Avara
Get started
API Reference

Orgs

Create a new organization
client.orgs.create(OrgCreateParams { orgName, metadata } body, RequestOptionsoptions?): OrgCreateResponse { createdAt, isActive, orgId, 6 more }
post/v1/orgs
List organizations with pagination
client.orgs.list(OrgListParams { cursor, limit } query?, RequestOptionsoptions?): CursorOrganizations<OrgListResponse { createdAt, isActive, orgId, 6 more } >
get/v1/orgs
Retrieve an organization by ID
client.orgs.retrieve(stringorgID, RequestOptionsoptions?): OrgRetrieveResponse { createdAt, isActive, orgId, 6 more }
get/v1/orgs/{orgId}
Update an organization
client.orgs.update(stringorgID, OrgUpdateParams { metadata, orgName } body?, RequestOptionsoptions?): OrgUpdateResponse { createdAt, isActive, orgId, 6 more }
patch/v1/orgs/{orgId}
Deactivate an organization
client.orgs.deactivate(stringorgID, RequestOptionsoptions?): OrgDeactivateResponse { createdAt, isActive, orgId, 6 more }
post/v1/orgs/{orgId}/deactivate
Reactivate an organization
client.orgs.reactivate(stringorgID, RequestOptionsoptions?): OrgReactivateResponse { createdAt, isActive, orgId, 6 more }
post/v1/orgs/{orgId}/reactivate

OrgsUsers

Add a user to an organization
client.orgs.users.add(stringorgID, UserAddParams { userId } body, RequestOptionsoptions?): UserAddResponse { success, message }
post/v1/orgs/{orgId}/users
Remove a user from an organization
client.orgs.users.remove(stringorgID, UserRemoveParams { userId } body, RequestOptionsoptions?): UserRemoveResponse { success, message }
delete/v1/orgs/{orgId}/users