GET
/
{version}
/
users
/
{user}
/
fields
curl --request GET \
  --url https://api.perscom.io/{version}/users/{user}/fields \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "key": "<string>",
      "type": "<string>",
      "cast": "<string>",
      "description": "<string>",
      "placeholder": "<string>",
      "default": "<string>",
      "help": "<string>",
      "required": true,
      "rules": "<string>",
      "readonly": true,
      "hidden": true,
      "options": [
        {}
      ],
      "label": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
user
integer
required

Response

200
application/json
OK
​
data
object[]
​
links
object
​
meta
object

Was this page helpful?

Update pivotCreate field