Projects

Get a project's custom fields

Returns every custom field the project's type defines, in display order, each paired with this project's value for it (null when unset).

The same list the project itself embeds — read it here when you only want the custom fields, and via GET /projects/{projectId} when you want them alongside the project.

Requires the permission to view project settings. Without it this endpoint returns 403, and the project representation omits its custom_fields key rather than returning an empty list.

get/projects/{projectId}/custom-fields

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/projects/{projectId}/custom-fields
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Path parameters

projectIdstring uuid required

Rabbet project UUID. To resolve your own identifier to a project, use GET /projects?custom_id=....

Response

The project's custom fields.

Example response

{
  "data": {
    "custom_fields": [
      {
        "id": "b308e77f-6d1d-47c4-bd1f-0069cc548315",
        "label": "Project Number",
        "field_name": "loan_id",
        "type": "text",
        "value": "PN123"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.