Skip to main content
GET
/
api2
/
v1
/
customFields
Lists custom fields
curl --request GET \
  --url https://cloud.memsource.com/web/api2/v1/customFields
{
  "totalElements": 123,
  "totalPages": 123,
  "pageSize": 123,
  "pageNumber": 123,
  "numberOfElements": 123,
  "content": [
    {
      "uid": "<string>",
      "name": "<string>",
      "type": "MULTI_SELECT",
      "allowedEntities": [
        "PROJECT"
      ],
      "options": {
        "truncatedOptions": [
          {
            "uid": "<string>",
            "value": "<string>",
            "deprecated": true,
            "used": true
          }
        ],
        "remainingCount": 123
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "firstName": "<string>",
        "lastName": "<string>",
        "userName": "<string>",
        "email": "<string>",
        "role": "SYS_ADMIN",
        "id": "<string>",
        "uid": "<string>"
      },
      "lastModified": "2023-11-07T05:31:56Z",
      "lastModifiedBy": {
        "firstName": "<string>",
        "lastName": "<string>",
        "userName": "<string>",
        "email": "<string>",
        "role": "SYS_ADMIN",
        "id": "<string>",
        "uid": "<string>"
      },
      "requiredFrom": "2023-11-07T05:31:56Z",
      "required": true,
      "description": "<string>"
    }
  ],
  "sort": {
    "orders": [
      {
        "direction": "ASC",
        "property": "<string>"
      }
    ]
  }
}

Query Parameters

​
pageNumber
integer
default:0

Page number, starting with 0, default 0

Required range: x >= 0
​
pageSize
integer
default:50

Page size, accepts values between 1 and 50, default 50

Required range: 1 <= x <= 50
​
name
string

Filter by custom field name

​
allowedEntities
enum<string>[]

Filter by custom field allowed entities

​
types
enum<string>[]

Filter by custom field types

​
createdBy
string[]

Filter by custom field creators UIDs

​
modifiedBy
string[]

Filter by custom field updaters UIDs

​
uids
string[]

Filter by custom field UIDs

​
required
boolean

Filter by custom field required parameter

​
sortField
enum<string>

Sort by this field

Available options:
NAME,
CREATED,
LAST_MODIFIED
​
sortTrend
enum<string>
default:ASC

Sort direction

Available options:
ASC,
DESC

Response

successful operation

​
totalElements
integer
​
totalPages
integer
​
pageSize
integer
​
pageNumber
integer
​
numberOfElements
integer
​
content
object[]
​
sort
object
⌘I