The PersonFieldValue API from Bridgit — 2 operation(s) for personfieldvalue.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/bridgit-personfieldvalue-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Bench Person Field Value API
description: 'Versioning
The API is currently at version 1.0.'
version: '1.0'
servers:
- url: https://bench.gobridgit.com
description: Bridgit Bench production
security:
- {}
tags:
- name: PersonFieldValue
paths:
/rp/api/v1/accounts/{accountId}/persons/{personId}/person-field-values:
get:
tags:
- PersonFieldValue
summary: Gets all custom field values for the given person
description: 'Permissions
Person: Read
HourlyProfile: Read
Private: Read
Finance: Read'
operationId: PersonFieldValue_QueryFieldValues
parameters:
- name: accountId
in: path
description: The Account ID
required: true
schema:
type: integer
format: int32
- name: personId
in: path
description: The Person ID
required: true
schema:
type: integer
format: int64
- name: includeEmpty
in: query
description: If true, the response will include all person field values, even if no value is set for a given field. If false, field values that are empty are not included in the response.
schema:
type: boolean
default: false
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/FieldValuesResponse'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FieldValuesResponse'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/FieldValuesResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
post:
tags:
- PersonFieldValue
summary: Add or update one or more custom field values on a person
description: 'It is mandatory that the fields with isRequired set to true be passed in as part of the request.
Example: Say you have 2 person fields on an account "Contact Number" and "Certifications" where isRequired is set to true on "Contact Number".
FieldDefinition Example Response - GET PersonFields (/api/v{version}/accounts/{id}/person-fields)
[
{
"id": 1394,
"name": "Contact Number",
"type": "PhoneNumber",
"isRequired": true,
"isSystem": false,
"isPrivate": false,
"isFinancials": false,
"isLocked": false
},
{
"id": 1395,
"name": "Certifications",
"type": "Text",
"isRequired": false,
"isSystem": false,
"isPrivate": false,
"isFinancials": false,
"isLocked": false
}
]
If you only send in the following your request will result in a 400.
[
{
"fieldId": 1395,
"values": [
"First Aid"
]
}
]
Validation
Single List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Multi List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Text: Min length: 0. Max length: 250
Date selector: Format: dd/MM/yyyy
Other: Max length: 2400
Checkbox: Accepted values: ```true``` or ```false```
Currency: ^[0-9]{0,15}(\\.[0-9]{0,2})?$
Currency should be greater or equal to zero, starts with 0 to 15 digits of ```0-9``` then optionally followed by ```.``` with 0 to 2 digits of ```0-9```
Phone: ^\\+[1-9]\d{10,14}$
Phone starts with a ```+``` followed by 11 to 15 digits of ```0-9``` where the first digit is not ```0```
Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read'
operationId: PersonFieldValue_SetFieldValues
parameters:
- name: accountId
in: path
description: The Account ID
required: true
schema:
type: integer
format: int32
- name: personId
in: path
description: The Person ID
required: true
schema:
type: integer
format: int64
requestBody:
description: ''
content:
application/json-patch+json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
application/json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
text/json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
application/*+json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
required: true
responses:
'200':
description: OK
'204':
description: No Content (success)
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - User doesn't have permissions on this resource, or the account or person couldn't be found
'422':
description: Unprocessable Entity
patch:
tags:
- PersonFieldValue
summary: Update field values on a person
description: 'Validation
Single List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Multi List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Text: Min length: 0. Max length: 250
Date selector: Format: dd/MM/yyyy
Other: Max length: 2400
Checkbox: Accepted values: ```true``` or ```false```
Currency: ^[0-9]{0,15}(\\.[0-9]{0,2})?$
Currency should be greater or equal to zero, starts with 0 to 15 digits of ```0-9``` then optionally followed by ```.``` with 0 to 2 digits of ```0-9```
Phone: ^\\+[1-9]\d{10,14}$
Phone starts with a ```+``` followed by 11 to 15 digits of ```0-9``` where the first digit is not ```0```
Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read'
operationId: PersonFieldValue_BulkUpdateFieldValues
parameters:
- name: accountId
in: path
description: The Account ID
required: true
schema:
type: integer
format: int32
- name: personId
in: path
description: The Person ID
required: true
schema:
type: integer
format: int64
requestBody:
description: ''
content:
application/json-patch+json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
application/json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
text/json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
application/*+json:
schema:
minItems: 1
type: array
items:
$ref: '#/components/schemas/FieldValuesPair'
required: true
responses:
'200':
description: OK
'204':
description: No Content (success)
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - User doesn't have permissions on this resource, or the account or person couldn't be found
delete:
tags:
- PersonFieldValue
summary: Delete one or more custom field values for a person
description: 'Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read'
operationId: PersonFieldValue_ClearFieldValues
parameters:
- name: accountId
in: path
description: The Account ID
required: true
schema:
type: integer
format: int32
- name: personId
in: path
description: The Person ID
required: true
schema:
type: integer
format: int64
requestBody:
description: The field IDs for which the custom values should be deleted
content:
application/json-patch+json:
schema:
minItems: 1
type: array
items:
type: integer
format: int64
application/json:
schema:
minItems: 1
type: array
items:
type: integer
format: int64
text/json:
schema:
minItems: 1
type: array
items:
type: integer
format: int64
application/*+json:
schema:
minItems: 1
type: array
items:
type: integer
format: int64
required: true
responses:
'200':
description: OK
'204':
description: No Content (success)
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - User doesn't have permissions on this resource, or the account or person couldn't be found
/rp/api/v1/accounts/{accountId}/persons/{personId}/person-field-values/{fieldId}:
patch:
tags:
- PersonFieldValue
summary: Update a single field's value(s) for person in the given account
description: 'Validation
Single List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Multi List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Text: Min length: 0. Max length: 250
Date selector: Format: dd/MM/yyyy
Other: Max length: 2400
Checkbox: Accepted values: ```true``` or ```false```
Currency: ^[0-9]{0,15}(\\.[0-9]{0,2})?$
Currency should be greater or equal to zero, starts with 0 to 15 digits of ```0-9``` then optionally followed by ```.``` with 0 to 2 digits of ```0-9```
Phone: ^\\+[1-9]\d{10,14}$
Phone starts with a ```+``` followed by 11 to 15 digits of ```0-9``` where the first digit is not ```0```
Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read'
operationId: PersonFieldValue_UpdateFieldValue
parameters:
- name: accountId
in: path
description: The Account ID
required: true
schema:
type: integer
format: int32
- name: personId
in: path
description: The Person ID
required: true
schema:
type: integer
format: int64
- name: fieldId
in: path
description: The field ID
required: true
schema:
type: integer
format: int64
requestBody:
description: ''
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/FieldValuesRequest'
application/json:
schema:
$ref: '#/components/schemas/FieldValuesRequest'
text/json:
schema:
$ref: '#/components/schemas/FieldValuesRequest'
application/*+json:
schema:
$ref: '#/components/schemas/FieldValuesRequest'
required: true
responses:
'200':
description: OK
'204':
description: No Content (success)
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - User doesn't have permissions on this resource, or the account or person couldn't be found
'422':
description: Unprocessable Entity
components:
schemas:
FieldValuesResponse:
type: object
properties:
fieldId:
type: integer
format: int64
example: 1394
name:
type:
- string
- 'null'
example: Contact Number
type:
enum:
- Boolean
- Date
- Email
- PhoneNumber
- Image
- Text
- LongText
- SingleSelect
- MultiSelect
- Address
- Currency
- Phone
- Integer
- Number
type: string
example: PhoneNumber
values:
type:
- array
- 'null'
items:
type: string
example:
- '5195555555'
isRequired:
type: boolean
isSystem:
type: boolean
example: false
isPrivate:
type: boolean
example: true
isFinancials:
type: boolean
example: true
lastModifiedOn:
type:
- string
- 'null'
format: date-time
example: '2021-05-27T10:58:23.530Z'
additionalProperties: false
FieldValuesRequest:
type: object
properties:
values:
type:
- array
- 'null'
items:
type: string
example:
- '5195555555'
additionalProperties: false
FieldValuesPair:
type: object
properties:
fieldId:
type: integer
format: int64
example: 1394
values:
type:
- array
- 'null'
items:
type: string
example:
- '5195555555'
additionalProperties: false
securitySchemes:
Bearer:
type: http
description: Standard Authorization header using the Bearer scheme
scheme: bearer
bearerFormat: JWT