Fields

Name
id
Type
string
Description
Unique identifier of the field.
Name
name
Type
object
Description
The name of the field.
- Name
  fr
  Type
  string
  Description
  The french name of the field.
Name
type
Type
string
Description
Type of the value: string, textarea, number, radio, select, multipleSelect, checkbox, date, datetime or rating.
Name
section
Type
object
Description
The section the field belongs to.
- Name
  id
  Type
  string
  Description
  The id of the field section.
- Name
  name
  Type
  string
  Description
  The name of the field section.
- Name
  entity
  Type
  string
  Description
  The entity of field section.

GET/api/v3.0/fields

Field List

This endpoint allows you to retrieve a list of fields.

Optional parameters

Name
section_id
Type
string
Description
The id of the field section.

Request

GET

/api/v3.0/fields

curl -G https://api.bob-desk.com/api/v3.0/fields \
  -H "Authorization: Bearer {token}" \
  -d section_id="6810ec7f43b86349e1756b49" \

Response

{
"fields": [
    {
      "id": "66389a92d4db9e001240fb7c",
      "name": {
        "fr": "Surface"
      },
      "type": "number",
      "section": {
        "id": "6810ec7f43b86349e1756b49",
        "name": "Immobilier",
        "entity": "location",
      }
    }
  ]
}

GET/api/v3.0/fields/:id

Read a field

This endpoint allows you to retrieve a specific field by its ID.

Path parameters

Name
id
Type
string
Description
Unique identifier of the field to retrieve.

Request

GET

/api/v3.0/fields/:id

curl https://api.bob-desk.com/api/v3.0/fields/66389a92d4db9e001240fb7c \
  -H "Authorization: Bearer {token}"

Response

{
"field": {
    "id": "66389a92d4db9e001240fb7c",
    "name": {
      "fr": "Surface"
    },
    "type": "number",
    "section": {
      "id": "6810ec7f43b86349e1756b49",
      "name": "Immobilier",
      "entity": "location",
    }
  }
}