List all workplaces

get

List workplaces

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

Query parameters

limitinteger · max: 100Optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Default: 10

startingAfterstringOptional

A cursor for use in pagination. startingAfter is a workplace ID.

endingBeforestringOptional

A cursor for use in pagination. endingBefore is a workplace ID.

placeIdstringOptional

Only return the workplaces with the specified place ID.

tagsstring[]Optional

Only return the workplaces with any of the specified tags.

Responses

200

Successful Response

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/agents/{agentId}/workplaces

HTTPcURLJavaScriptPython

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

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