GET/projects/api/v2/projects.json

Get Custom Fields on projects

Getting a list of projects with their custom fields requires you to pass in ?includeCustomFields=true.

A list of projects will be returned along with the custom fields associated with them. This is a paged API with pagination set at 50. To get the next page, you must pass in page parameter.

If a project doesn't have any custom fields set, project.customFields is omitted from the response, not null.

Please note: The V1 /projects.json endpoint does not support includeCustomFields=true, you must use this V2 API.

Query Params

  • Name
    page
    Type
    number
    Description
  • Name
    pageSize
    Type
    number
    Description
  • Name
    includeCustomFields
    Type
    boolean
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{  "STATUS": "consectetur anim Excepteur",  "customFields": {    "226": {      "id": -12744963,      "projectId": null,      "entity": "dolor",      "name": "aliquip quis",      "description": "laborum in reprehenderit sint ipsum",      "type": "nostrud aute",      "options": null,      "visibilities": [        {},        {},        {},        {}      ],      "isPrivate": true,