---
updatedAt: 2025-10-16T12:49:08.000Z
agentTools:
  projectIndex: https://clayhr.readme.io/llms.txt
---

# Retrieve my active allocations.

Retrieve list of active allocations of user.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "description": "API Documentation",
    "version": "1.0",
    "title": "BizMerlinHR REST APIs",
    "termsOfService": "https://www.clayhr.com/terms-of-service/"
  },
  "tags": [
    {
      "name": "Timesheets",
      "description": "List of APIs for Timesheets"
    }
  ],
  "paths": {
    "/api/timesheet/allocations/list": {
      "get": {
        "tags": [
          "Timesheets"
        ],
        "summary": "Retrieve my active allocations.",
        "description": "Retrieve list of active allocations of user.",
        "operationId": "getAllocationsListUsingGET",
        "parameters": [
          {
            "name": "x-api-key",
            "in": "header",
            "description": "The API key of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "string",
              "example": ""
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "The ID of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "example": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"projectId\": \"int\",\n            \"projectName\": \"string\",\n            \"projectDesc\": \"string\",\n            \"startDate\": \"date\",\n            \"endDate\": \"date\",\n            \"contactPerson\": \"long\",\n            \"account\": \"long\",\n            \"status\": \"string\",\n            \"createts\": \"int\",\n            \"shortCode\": \"string\",\n            \"probability\": \"int\",\n            \"contactPersonName\": \"string\",\n            \"statusValue\": \"string\",\n            \"puid\": \"string\",\n            \"billingType\": \"string\",\n            \"timeSheetOpenToAll\": \"int\",\n            \"projectGroupModel\": \"string\",\n            \"locationModel\": \"string\",\n            \"customFieldValueModelList\": \"object\",\n            \"billinCategoryModels\": \"string\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "projectId": {
                            "type": "string",
                            "example": "int"
                          },
                          "projectName": {
                            "type": "string",
                            "example": "string"
                          },
                          "projectDesc": {
                            "type": "string",
                            "example": "string"
                          },
                          "startDate": {
                            "type": "string",
                            "example": "date"
                          },
                          "endDate": {
                            "type": "string",
                            "example": "date"
                          },
                          "contactPerson": {
                            "type": "string",
                            "example": "long"
                          },
                          "account": {
                            "type": "string",
                            "example": "long"
                          },
                          "status": {
                            "type": "string",
                            "example": "string"
                          },
                          "createts": {
                            "type": "string",
                            "example": ""
                          },
                          "shortCode": {
                            "type": "string",
                            "example": "string"
                          },
                          "probability": {
                            "type": "string",
                            "example": "int"
                          },
                          "contactPersonName": {
                            "type": "string",
                            "example": "string"
                          },
                          "statusValue": {
                            "type": "string",
                            "example": "string"
                          },
                          "puid": {
                            "type": "string",
                            "example": "string"
                          },
                          "billingType": {
                            "type": "string",
                            "example": ""
                          },
                          "timeSheetOpenToAll": {
                            "type": "string",
                            "example": "int"
                          },
                          "projectGroupModel": {
                            "type": "string",
                            "example": ""
                          },
                          "locationModel": {
                            "type": "string",
                            "example": ""
                          },
                          "customFieldValueModelList": {
                            "type": "string",
                            "example": ""
                          },
                          "billinCategoryModels": {
                            "type": "string",
                            "example": ""
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"Access denied! Either Authorization or x-api-key & userid parameters are not present/valid or you don't have the necessary permissions.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Access denied! Either Authorization or x-api-key & userid parameters are not present/valid or you don't have the necessary permissions."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"message\":\"failure\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "failure"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "servers": [
    {
      "url": "//acmecompany.clayhr.com/rm"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "security": []
}
```