Skip to main content
POST
/
api
/
v1
/
task
/
projects
Get Projects List
curl --request POST \
  --url https://api.xenia.team/api/v1/task/projects \
  --header 'Content-Type: application/json' \
  --header 'x-client-key: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "advanceFilters": {
    "condition": "AND",
    "filters": [
      {
        "filterName": "assignees",
        "comparator": "is",
        "value": [
          "dfea8b8a-5b22-4668-b68d-dc641eb3a101"
        ],
        "conditional": "and"
      },
      {
        "filterName": "categories",
        "comparator": "is",
        "value": [
          "50d9f381-eba0-41b0-b26b-70a47a854252"
        ],
        "conditional": "and"
      },
      {
        "filterName": "locations",
        "comparator": "is",
        "value": [
          "a13ddb59-3e5c-4bdd-8673-fc913b93b9db"
        ],
        "conditional": "and"
      },
      {
        "filterName": "scheduleFrequency",
        "comparator": "is",
        "value": [
          "Daily",
          "Weekly",
          "Monthly"
        ],
        "conditional": "and"
      }
    ]
  },
  "offset": 0,
  "limit": 100,
  "includeAll": false,
  "status": "ACTIVE"
}'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "assignees": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "assigneesRoles": [
        "<any>"
      ],
      "locationIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "locationCount": "<string>",
      "isPaused": true,
      "type": "<string>",
      "state": "<string>",
      "recurringTask": true,
      "timezone": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "startTime": "2023-11-07T05:31:56Z",
      "dueTime": "2023-11-07T05:31:56Z",
      "requestThisTask": "Daily",
      "intervalWeek": [
        "Mon"
      ],
      "recurringByEvery": "<string>",
      "anyTaskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "totalSchedules": "<string>",
      "activeTasksCount": "<string>",
      "completedTasksCount": "<string>",
      "completionRate": "<string>",
      "nextDueDate": "2023-11-07T05:31:56Z",
      "nextDueTimezone": "<string>",
      "calculatedNextDue": true
    }
  ],
  "extra_meta": {}
}

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Body

application/json
offset
integer
required
Example:

0

limit
integer
required
Example:

100

advanceFilters
object

Advanced filters for querying projects

includeAll
boolean
Example:

false

status
enum<string>

Filter projects by status

Available options:
ACTIVE,
PAUSED,
EXPIRED

Response

200 - application/json

List of filtered projects

data
object[]
extra_meta
object
I