careCycle
CampaignsAppointment configs

List appointment configs

List all appointment configs for the client

GET
/v2/campaigns/appointment-configs

Authorization

x-api-key
x-api-key<token>

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.carecycle.ai/v2/campaigns/appointment-configs"
{
  "appointmentConfigs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdAt": null,
      "updatedAt": null,
      "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
      "name": "string",
      "concurrentLimit": -2147483648,
      "appointmentLength": -2147483648,
      "appointmentSpacing": -2147483648,
      "maxOptions": -2147483648,
      "minDate": "string",
      "maxDate": "string",
      "minHours": -2147483648,
      "preferredMode": "timezone",
      "pulseWorkflowId": "6cbf4411-f62a-452f-b47e-a87913280a83",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
    }
  ],
  "total": 0
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "string"
}
{
  "message": "string",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "path": [
        "string"
      ],
      "message": "string",
      "expected": "string",
      "received": "string",
      "code": "string"
    }
  ]
}
{
  "message": "string",
  "code": "string",
  "retryAfter": 0
}
{
  "message": "string",
  "code": "string"
}