--- title: "Get project preferences" method: GET path: "/api/v2/project_preferences" tags: ["Project Preferences"] --- # Get project preferences `GET /api/v2/project_preferences` ## Request - Base URL: `https://developer.productive.io` (the document declares no server; this is the origin it was published from) - URL: `https://developer.productive.io/api/v2/project_preferences` - Auth: none declared Returns a paginated list of project preferences, limited to projects the current user can see. Scope the list with `filter[project_id]` or `filter[person_id]`. ## Query parameters - `filter` union: Filter schema for `project_preference` list endpoints — pass a single condition or a logical group. - object: A logical filter group — combine multiple conditions with the `$op` operator. - `$op` 'or' | 'and', required: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. - FilterProjectPreference: Filter parameters for listing project preferences — filter by `id`, `person_id` or `project_id`. Standard integer operators apply. - `id` union: Filter by project preference ID. - object: Filter using explicit operator syntax. - `eq` Id (unresolved $ref) - `not_eq` Id (unresolved $ref) - `contains` Id (unresolved $ref) - `not_contain` Id (unresolved $ref) - Id (unresolved $ref) - `person_id` union: Filter by the person the preference belongs to. - object: Filter using explicit operator syntax. - `eq` PersonId (unresolved $ref) - `not_eq` PersonId (unresolved $ref) - `contains` PersonId (unresolved $ref) - `not_contain` PersonId (unresolved $ref) - PersonId (unresolved $ref) - `project_id` union: Filter by the project the preference applies to. - object: Filter using explicit operator syntax. - `eq` ProjectId (unresolved $ref) - `not_eq` ProjectId (unresolved $ref) - `contains` ProjectId (unresolved $ref) - `not_contain` ProjectId (unresolved $ref) - ProjectId (unresolved $ref) - `sort` string[] ## Response `200` Paginated list of project preferences. - object: Paginated list of project preference records in JSON:API format. - `data` object[]: Array of project preference resource objects. - `attributes` object: Project preference attributes. - `created_at` CreatedAt (unresolved $ref) - `preferences` Preferences (unresolved $ref) - `tasks_layout_id` TasksLayoutId (unresolved $ref) - `watched` Watched (unresolved $ref) - `relationships` object: Project preference relationships. - `person` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `project` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `included` unknown[]: Sideloaded related resources. - unknown - `meta` Meta: Pagination and response metadata returned with every collection endpoint. - `current_page` integer: The current page number in this paginated response (1-based). - `max_page_size` integer: Maximum number of records allowed per page for this endpoint. - `organization_features` object: Feature flags and capabilities enabled for the current organization, used for UI rendering. - `page_size` integer: Number of records returned per page in this response. - `settings` object: Organization or user settings relevant to this resource's display. - `total_count` integer: Total number of records matching the current query across all pages. - `total_pages` integer: Total number of pages available for the current query and page size. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `408`: Request Timeout - `423`: Locked - `429`: Too Many Requests - `500`: Internal Server Error ## Changes - **2026-11-02** `fa3060fd0144`: 6 info - added the non-success response with the status `400` - added the non-success response with the status `401` - added the non-success response with the status `408` - added the non-success response with the status `423` - …2 more - **2026-10-27** `f11a8740641a`: 3 breaking, 1 warning, 11 info - the `data/items/attributes/preferences` response's property type changed from `string` to no type for status `200` - the `data/items/attributes/tasks_layout_id` response's property type changed from `integer` to no type for status `200` - the `data/items/attributes/watched` response's property type changed from `boolean` to no type for status `200` - deleted the `header` request parameter `X-Organization-Id` - …11 more - …this revision’s changelog is incomplete - **2026-09-09** `1002e31dc640`: 1 info - endpoint added [Operation history](https://skmtc.dev/productive/apis/api-documentation/changes/api/v2/project_preferences/get.md) --- [API](https://skmtc.dev/productive/apis/api-documentation.md) - [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/productive/apis/api-documentation/revisions/e7bdfdf6cba3?raw)