The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Dev guideRecipesAPI ReferenceChangelog
Dev guideAPI ReferenceRecipesChangelogUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

List Custom Fields

Get a list of Custom Fields within a Project

You can use query parameters to filter/sort the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The project identifier

Query Params
int64

The max number of items to include per page or results.

string

Pagination page token. Implements prev, next, last, first

integer

Number of previous and next page links to supply for the request (defaults to 1).

string

Substring search across key, name and description (case-insensitive).

sort
array of strings

Sort the custom fields based on the attributes from left to right.

sort
boolean

Filter the custom fields by archived. A custom field can be either archived (archived=true) or unarchived (archived=false)

string

Filter the custom fields by key.

string
enum

Filter the custom fields by entity type.

Allowed:
string
enum

Filter the custom fields by field type.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Not found. No content

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json