List custom field definitions
Requires custom-fields:read. Returns a cursor page. Query predicates are AND-combined; in matches any listed value.
curl -X GET "https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app.inrepli.com/v1/custom-field-definitions?limit=50&cursor=example_string&count=null&sort=-createdAt&objectType=null&status=ACTIVE')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"data": [
{
"id": "example-id-5",
"key": "segment",
"dataType": "SINGLE_SELECT",
"status": "ACTIVE",
"createdAt": "2026-09-09T06:34:58.430Z",
"updatedAt": "2026-09-09T06:34:58.430Z",
"archivedAt": null,
"label": "Segment",
"objectType": "contact",
"nullable": true,
"required": false,
"readable": true,
"writable": false,
"filterable": true,
"sortable": false,
"allowedOperators": [
"eq",
"in",
"isNull"
],
"options": [
{
"value": "enterprise",
"label": "Enterprise"
}
]
}
],
"nextCursor": null
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/custom-field-definitions
Target server for requests. Edit to use your own host.
Tenant API key beginning with inr_v1_.
Page size.
Opaque nextCursor from the preceding page. Preserve filters, q, sort, count and include. Bound to tenant and key scopes; not a snapshot.
Optional complete filtered count.
Comma-separated fields: createdAt. Prefix - for descending. Default -createdAt; at most two distinct fields. Server appends id as a tie-breaker; nullable values sort last.
Object whose custom definitions are requested.
Definition status.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Tenant API key beginning with inr_v1_.
Query Parameters
Page size.
Opaque nextCursor from the preceding page. Preserve filters, q, sort, count and include. Bound to tenant and key scopes; not a snapshot.
Comma-separated fields: createdAt. Prefix - for descending. Default -createdAt; at most two distinct fields. Server appends id as a tie-breaker; nullable values sort last.