Retrieve a workplace

get

Get a workplace.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

workplaceIdstringRequired

The ID of the workplace.

Responses

200

Successful Response

application/json

This an object representing a workplace.

idstringRequired

namestringRequired

descriptionstringOptional

websitestringOptional

phoneNumberstringOptional

emailstringOptional

addressstringOptional

socialLinksobjectOptional

tagsstring[]Optional

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get

/v1/agents/{agentId}/workplaces/{workplaceId}

HTTPcURLJavaScriptPython

GET /v1/agents/{agentId}/workplaces/{workplaceId} HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "website": "text",
  "phoneNumber": "text",
  "email": "text",
  "address": "text",
  "socialLinks": {},
  "tags": [
    "text"
  ]
}