custom-field

Get Many Custom Fields

Get Many Custom Fields

Securitybearer
Request
query Parameters
select
Array of strings

Select Custom Field fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "type" "name" "label"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Custom Fields. (e.g. limit=20)

offset
integer

Offset amount of received Custom Fields. (e.g. offset=20)

object

Sort received Custom Fields by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/custom-field
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/custom-field?select=SOME_ARRAY_VALUE&filters=SOME_OBJECT_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&sort=SOME_OBJECT_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Get One Custom Field

Get One Custom Field

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Custom Field fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "type" "name" "label"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/custom-field/{id}
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/custom-field/507f1f77bcf86cd799439011?select=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}