GET Custom Fields

Returns the custom fields for the given company.

GET /platform/api/custom_fields

GET Custom Fields

cURL

curl --request GET \
  --url https://api.rippling.com/platform/api/custom_fields \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rippling.com/platform/api/custom_fields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rippling.com/platform/api/custom_fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rippling.com/platform/api/custom_fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rippling.com/platform/api/custom_fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rippling.com/platform/api/custom_fields")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rippling.com/platform/api/custom_fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "type": "SELECT",
    "title": "What is your race / ethnicity?",
    "caption": null,
    "required": false
  },
  {
    "type": "SELECT",
    "title": "Veteran Status",
    "caption": null,
    "required": false
  },
  {
    "type": "SELECT",
    "title": "What is your Gender?",
    "caption": null,
    "required": false
  },
  {
    "type": "SELECT",
    "title": "Disability Status",
    "caption": null,
    "required": false
  },
  {
    "type": "SELECT",
    "title": "How will this employee be classified for EEO reporting?",
    "caption": null,
    "required": true
  },
  {
    "type": "NUMBER",
    "title": "Data2",
    "caption": null,
    "required": true
  },
  {
    "type": "DATE",
    "title": "Data1",
    "caption": null,
    "required": true
  },
  {
    "type": "TEXTAREA",
    "title": "Data3",
    "caption": null,
    "required": true
  },
  {
    "type": "TEXT",
    "title": "Data4",
    "caption": null,
    "required": true
  },
  {
    "type": "TEXT",
    "title": "send notification again",
    "caption": null,
    "required": true
  },
  {
    "type": "FILE",
    "title": "offboard",
    "caption": null,
    "required": true
  },
  {
    "type": "TEXT",
    "title": "severance test variable",
    "caption": null,
    "required": false
  },
  {
    "type": "TEXT",
    "title": "Favorite Animal",
    "caption": null,
    "required": true
  },
  {
    "type": "TEXT",
    "title": "additional variable",
    "caption": null,
    "required": true
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

Sets a limit on the returned values

offset · integer

Offsets the returned values

Response

200 - application/json

OK

Id · string

The identifier of the specific custom field.

type · enum<string>

Denotes the type of the custom field.

Available options: TEXT, DATE, NUMBER, CURRENCY, PERCENTAGE, SELECT, FILE, ID, RADIO, TEXTAREA

title · string

The title of the custom field.

required · boolean

Denotes whether the custom field is or is not mandatory