Skip to main content

List people allocations

GET 
/api/people-allocations

Required permissions:

  • planning.view: allows view of resources owned by the user.
  • planning.view_other: allows of view resources not owned by the user.

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    Examples:

    Exclude soft-deleted records.

    Example: exclude

    deleted_at date-time

    Filter items by the deleted_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items deleted on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    date date

    Filter items by the date field. This follow the YYYY-MM-DD format.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01

    project_id integer

    The ID of the project to filter the results on.

    person_id integer

    The ID of the person to filter the results on.

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of people allocation resources.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    date daterequired
    hours integerrequired

    Possible values: <= 8

    project_id integerrequired

    Possible values: >= 1

    ID of the project related to this allocation

    person_id integerrequired

    Possible values: >= 1

    ID of the person related to this allocation

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

Loading...