---
updatedAt: 2026-06-22T15:32:35.000Z
agentTools:
  projectIndex: https://docs.oysterhr.com/llms.txt
---

# Returns list of offboardings

This API endpoint allows you to retrieve a list of offboardings.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Endpoints",
    "version": "v1"
  },
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "offboarding": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "engagement": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "countryCode": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "countryCode"
            ]
          },
          "state": {
            "type": "string"
          },
          "cancelledAt": {
            "type": "string",
            "nullable": true
          },
          "initiatedAt": {
            "type": "string",
            "nullable": true
          },
          "cancelReason": {
            "type": "string",
            "nullable": true
          },
          "requestorId": {
            "type": "string",
            "nullable": true
          },
          "category": {
            "type": "object",
            "nullable": true,
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "parentCategory": {
                "type": "object",
                "nullable": true,
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name"
                ]
              }
            },
            "required": [
              "id",
              "name"
            ]
          },
          "lastDayOn": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "id",
          "engagement",
          "state",
          "cancelledAt",
          "initiatedAt",
          "cancelReason",
          "requestorId",
          "category",
          "lastDayOn"
        ]
      },
      "offboardings": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/offboarding"
        }
      },
      "meta": {
        "type": "object",
        "properties": {
          "items": {
            "type": "integer"
          },
          "count": {
            "type": "integer"
          },
          "page": {
            "type": "integer"
          },
          "pages": {
            "type": "integer"
          },
          "firstUrl": {
            "type": "string"
          },
          "lastUrl": {
            "type": "string"
          },
          "pageUrl": {
            "type": "string"
          },
          "nextUrl": {
            "type": "string"
          },
          "prevUrl": {
            "type": "string"
          },
          "deprecation": {
            "type": "object",
            "properties": {
              "at": {
                "type": "string"
              },
              "sunset": {
                "type": "string"
              },
              "link": {
                "type": "object",
                "properties": {
                  "rel": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "required": [
          "items",
          "count",
          "page",
          "pages",
          "firstUrl",
          "lastUrl",
          "pageUrl",
          "nextUrl",
          "prevUrl"
        ]
      }
    }
  },
  "paths": {
    "/v1/offboardings/": {
      "get": {
        "summary": "Returns list of offboardings",
        "tags": [
          "Offboarding"
        ],
        "description": "This API endpoint allows you to retrieve a list of offboardings.",
        "security": [
          {
            "bearer_auth": [
              "read"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieves a list of offboardings",
            "content": {
              "application/json": {
                "examples": {
                  "Successfully retrieves a list of offboardings": {
                    "value": {
                      "data": [],
                      "meta": {
                        "items": 100,
                        "count": 0,
                        "page": 1,
                        "pages": 1,
                        "firstUrl": "/v1/offboardings?page=1&perPage=100",
                        "lastUrl": "/v1/offboardings?page=1&perPage=100",
                        "pageUrl": "/v1/offboardings?page=1&perPage=100",
                        "nextUrl": "/v1/offboardings?page=&perPage=100",
                        "prevUrl": "/v1/offboardings?page=&perPage=100"
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/offboardings"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/meta"
                    }
                  },
                  "required": [
                    "data",
                    "meta"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oysterhr.com",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.oysterhr.com",
      "description": "Sandbox server"
    }
  ]
}
```