List interaction statuses

Tenant statuses of type interaction, in display order.

RBAC · interaction

Response body

Success response 200 · schema InteractionStatusListV1

dataarray of objectRequired

itemsobject

status_idstring <uuid>Required

namestringRequired

is_closedbooleanRequired

is_defaultbooleanRequiredNullable

order_numbernumberRequiredNullable

metaobject

Response codes

200

Interaction statuses.

400

Validation or query parsing failure.

401

API key missing or invalid.

403

Interaction RBAC or assignment to another user’s schedule denied.

404

Interaction not found.

500

Unexpected controller or service failure.

GET /api/v1/interaction-statuses

cURL

curl -X GET "https://algapsa.com/api/v1/interaction-statuses" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/interaction-statuses", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/interaction-statuses");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "status_id": "01HN2K7VRB9PQ3Y0000000000",
      "name": "string",
      "is_closed": false,
      "is_default": false,
      "order_number": 0
    }
  ],
  "meta": {}
}