Fields

This page describes APIs relating to fields.

Get searchable field keys

get

/api/v3/fields

Returns searchable keys for students and parents. Use record_type=student or parent to scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

record_typestring · enumOptionalPossible values:

Responses

200

successful

application/json

Other propertiesanyOptional

get/api/v3/fields

GET /api/v3/fields HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

successful

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get field detail

get

/api/v3/fields/{id}

Returns detail of a field, including children/options when applicable.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Field ID

Responses

200

successful

application/json

404

field not found

application/json

get/api/v3/fields/{id}

GET /api/v3/fields/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "field": {
    "id": 1,
    "type": "text",
    "kind": "text",
    "label": "text",
    "name": "text",
    "slug": "text",
    "required": true,
    "office_use": true,
    "item_type": "text",
    "parent": 1,
    "options": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "children": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  }
}

Create an option

post

/api/v3/fields/{field_id}/options

Create an option under a custom single/multi option field.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

field_idintegerRequired

Field ID

Body

Responses

201

created

application/json

404

field not found

application/json

422

built-in field type cannot be modified

application/json

post/api/v3/fields/{field_id}/options

POST /api/v3/fields/{field_id}/options HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "option": {
    "name": "text",
    "position": 1,
    "active": true
  }
}

{
  "option": {
    "id": 1,
    "name": "text",
    "position": 1,
    "active": true,
    "field_id": 1
  }
}

Delete an option

delete

/api/v3/fields/{field_id}/options/{id}

Delete an option if it is not referenced by existing records.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

field_idintegerRequired

Field ID

idintegerRequired

Option ID

Responses

200

deleted

application/json

messagestringOptional

422

option in use

application/json

delete/api/v3/fields/{field_id}/options/{id}

DELETE /api/v3/fields/{field_id}/options/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Option deleted"
}

Update an option

patch

/api/v3/fields/{field_id}/options/{id}

Update an option name, position, and active status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

field_idintegerRequired

Field ID

idintegerRequired

Option ID

Body

Responses

200

updated

application/json

404

option not found

application/json

patch/api/v3/fields/{field_id}/options/{id}

PATCH /api/v3/fields/{field_id}/options/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "option": {
    "name": "text",
    "position": 1,
    "active": true
  }
}

{
  "option": {
    "id": 1,
    "name": "text",
    "position": 1,
    "active": true,
    "field_id": 1
  }
}