Get Organization

GET

api

vendors

{vendorId}

organizations

{organizationId}

Get Organization Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
    "companyName": "Example Corp",
    "industry": "Technology",
    "contact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "phoneNumber": "+491701234567",
      "country": "DE"
    },
    "plan": {
      "id": "c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b",
      "name": "Standard Tier"
    }
  },
  "traceId": "<string>"
}

Path Parameters

vendorId

string

required

ID of the Vendor (UUID)

organizationId

string

required

ID of the Organization (UUID)

Response

Successfully retrieved organization details

Standard API response wrapper

success

boolean

required

Indicates if the request was successful

Example:

true

timestamp

string<date-time>

required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

message

string

Human-readable message

data

object

Payload data object

Show child attributes

data.id

string

required

Unique identifier of the organization (UUID).

Example:

"f0e9d8c7-b6a5-4321-fedc-ba9876543210"

data.companyName

string

required

Name of the organization.

Example:

"Example Corp"

data.industry

string

required

Industry the organization operates in.

Example:

"Technology"

data.contact

object

required

Primary contact information for the organization.

Show child attributes

data.contact.firstName

string

required

First name of the contact.

Example:

"Jane"

data.contact.lastName

string

required

Last name of the contact.

Example:

"Doe"

data.contact.phoneNumber

string

required

Contact phone number (preferably E.164 format).

Example:

"+491701234567"

data.contact.country

string

required

Country code of the contact (ISO 3166-1 alpha-2).

Example:

"DE"

data.plan

object

required

Plan assigned to this organization (basic description).

Show child attributes

data.plan.id

string

required

Unique identifier of the plan (UUID).

Example:

"c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b"

data.plan.name

string

required

Name of the plan.

Example:

"Standard Tier"

traceId

string

Correlation or trace ID

Update OrganizationUpdates the details of an existing organization.

⌘I

Get Organization Details

curl --request GET \
  --url https://app.phonebot.io:80/api/v1/vendors/{vendorId}/organizations/{organizationId}

{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
    "companyName": "Example Corp",
    "industry": "Technology",
    "contact": {
      "firstName": "Jane",
      "lastName": "Doe",
      "phoneNumber": "+491701234567",
      "country": "DE"
    },
    "plan": {
      "id": "c4a9e3f8-a3b2-4d1c-8b7e-5a9f0d1e2c3b",
      "name": "Standard Tier"
    }
  },
  "traceId": "<string>"
}

Overview

Realtime

Assistants

Agents

Agent Tasks

Organizations

Plans

Vendors

Path Parameters

Response