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

Authorizations

​
Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Query Parameters

​
pageNumber
integer<int32>
default:0

Page number, starting with 0, default 0

Required range: x >= 0
​
pageSize
integer<int32>
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

Available options:
PROJECT,
JOB
​
types
enum<string>[]

Filter by custom field types

Available options:
MULTI_SELECT,
SINGLE_SELECT,
STRING,
NUMBER,
URL,
DATE
​
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

OK

​
content
object[]
​
numberOfElements
integer<int32>
​
pageNumber
integer<int32>
​
pageSize
integer<int32>
​
sort
object
​
totalElements
integer<int32>
​
totalPages
integer<int32>