Retrieve a custom field definition - Supercycle

Retrieve a custom field definition

curl --request GET \
  --url https://app.supercycle.com/api/v1/custom_field_definitions/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.supercycle.com/api/v1/custom_field_definitions/{id}"

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

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

print(response.text)

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

fetch('https://app.supercycle.com/api/v1/custom_field_definitions/{id}', 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://app.supercycle.com/api/v1/custom_field_definitions/{id}",
  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://app.supercycle.com/api/v1/custom_field_definitions/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.supercycle.com/api/v1/custom_field_definitions/{id}")

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

{
  "id": 123,
  "key": "<string>",
  "name": "<string>",
  "ownerType": "item",
  "type": "string",
  "groupFulfillments": true
}

{
  "error": "Rate limit exceeded. Retry after 42 seconds."
}

GET

/

custom_field_definitions

/

{id}

Retrieve a custom field definition

curl --request GET \
  --url https://app.supercycle.com/api/v1/custom_field_definitions/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.supercycle.com/api/v1/custom_field_definitions/{id}"

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

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

print(response.text)

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

fetch('https://app.supercycle.com/api/v1/custom_field_definitions/{id}', 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://app.supercycle.com/api/v1/custom_field_definitions/{id}",
  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://app.supercycle.com/api/v1/custom_field_definitions/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.supercycle.com/api/v1/custom_field_definitions/{id}")

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

{
  "id": 123,
  "key": "<string>",
  "name": "<string>",
  "ownerType": "item",
  "type": "string",
  "groupFulfillments": true
}

{
  "error": "Rate limit exceeded. Retry after 42 seconds."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

id

integer

required

Numeric ID of the custom field definition.

Response

Expected response to a valid request

id

integer<int64>

required

Numeric ID of the custom field definition.

key

string

required

Unique key identifier for the custom field.

name

string

required

Display name of the custom field.

ownerType

enum<string>

required

Type of resource this custom field applies to.

Available options:

item,

rental

type

enum<string>

required

Data type of the custom field value. image is in beta: it is part of the improved custom fields, which are enabled per shop, and only such a shop can hold or write one.

Available options:

string,

single_line_text_field,

money,

customer_reference,

rental_reference,

return_reference,

multi_line_text_field,

boolean,

date,

date_time,

integer,

item_reference,

color,

url,

json,

choice,

image

groupFulfillments

boolean

required

Whether this field groups fulfillments together.