REST DocumentationProjectsGET List locations assigned to a project

List locations assigned to a project

Returns a paginated list of locations assigned to the given project.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/projects/{id}/locations
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/projects/{id}/locations' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

  • Name
    id
    Type
    integer
    Description

    The project ID

Query parameters

  • Name
    page
    Type
    integer, nullable
    Description

    The page of results to return, counting from 1.

Response

{
  "data": [
    {
      "name": "EU",
      "description": "Angebot|en:offer",
      "project_id": 16
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

  • Name
    name
    Type
    string
    Description

    Name of the location.

  • Name
    description
    Type
    string, nullable
    Description

    Free-text description of the location.

  • Name
    project_id
    Type
    integer, nullable
    Description

    Identifier of the project this location is assigned to.

Generated from the OpenAPI specification — edit the source code, not this page.