SLA Policies | Bird API Docs

No-code docs

Get SLA policy

get

Authorizations

Path parameters

workspaceIdstringRequired

slaPolicyIdstring · uuidRequired

Responses

application/json

objectOptional

application/json

get

GET /workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timeKeepingMethod": "clock",
  "metrics": {
    "firstReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ],
    "nextReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ]
  },
  "createdAt": "2025-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}

Delete SLA policy

delete

Authorizations

Path parameters

workspaceIdstringRequired

slaPolicyIdstring · uuidRequired

Responses

application/json

delete

DELETE /workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List SLA policies

get

Authorizations

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

application/json

all ofOptional

A list of results that supports pagination.

get

GET /workspaces/{workspaceId}/inbox/sla-policies HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

200

A paginated list of SLA policies.

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "timeKeepingMethod": "clock",
      "metrics": {
        "firstReplyTime": [
          {
            "priority": "text",
            "breachThreshold": 1,
            "warningThreshold": 1
          }
        ],
        "nextReplyTime": [
          {
            "priority": "text",
            "breachThreshold": 1,
            "warningThreshold": 1
          }
        ]
      },
      "createdAt": "2025-04-18T23:56:11.593Z",
      "updatedAt": "2025-04-18T23:56:11.593Z"
    }
  ]
}

Create SLA policy

post

Authorizations

Path parameters

workspaceIdstringRequired

Body

namestringRequired

descriptionstringRequired

timeKeepingMethodstring · enumRequired

Determine how the timers are tracking expiry.

clock will simply count using the full 24 hours of a day.
businessHours takes into account the business hours configured for the assigned team.

Available options:

metricsobjectOptional

Responses

application/json

objectOptional

application/json

post

POST /workspaces/{workspaceId}/inbox/sla-policies HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "name": "text",
  "description": "text",
  "timeKeepingMethod": "clock",
  "metrics": {
    "firstReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ],
    "nextReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timeKeepingMethod": "clock",
  "metrics": {
    "firstReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ],
    "nextReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ]
  },
  "createdAt": "2025-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}

Update SLA policy

patch

Authorizations

Path parameters

workspaceIdstringRequired

slaPolicyIdstring · uuidRequired

Body

namestringOptional

descriptionstringOptional

timeKeepingMethodstring · enumOptional

Determine how the timers are tracking expiry.

clock will simply count using the full 24 hours of a day.
businessHours takes into account the business hours configured for the assigned team.

Available options:

metricsobjectOptional

Responses

application/json

objectOptional

application/json

patch

PATCH /workspaces/{workspaceId}/inbox/sla-policies/{slaPolicyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "name": "text",
  "description": "text",
  "timeKeepingMethod": "clock",
  "metrics": {
    "firstReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ],
    "nextReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timeKeepingMethod": "clock",
  "metrics": {
    "firstReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ],
    "nextReplyTime": [
      {
        "priority": "text",
        "breachThreshold": 1,
        "warningThreshold": 1
      }
    ]
  },
  "createdAt": "2025-04-18T23:56:11.593Z",
  "updatedAt": "2025-04-18T23:56:11.593Z"
}