Contacts

This page describes all the APIs relating to contacts.

Get all Contacts

get

https://api.openapply.comhttps://api.openapply.cn

/api/v3/contacts

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1Optional

The page number of results to return.

Default: 1

per_pageinteger · min: 1 · max: 200Optional

Request for how many records to return.

Default: 50

countintegerOptional

Synonym for per_page

Responses

200

successful

application/json

get

/api/v3/contacts

HTTPcURLJavaScriptPython

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

200

successful

{
  "contacts": [
    {
      "id": 1,
      "first_name": "Roland",
      "last_name": "Bayer",
      "lead": "Sign up for Admissions Information",
      "email": "[email protected]",
      "avatar_url": "/assets/fallback/thumb_default_avatar-9af962b3cff94e1532ddd91a97e977b8461383e9f4e7e33dfd573942a9de5e45.png?v=1600757575",
      "representative": "",
      "add_by_school": false,
      "source_campaign": {
        "id": 8,
        "campaign": "Facebook - 2020 - 03",
        "source": "Facebook"
      },
      "contact_date": "2020-09-22",
      "converted": false,
      "mailing_list": [],
      "email_campaign": [],
      "phone_number": "",
      "employer_company": "",
      "job_title": "",
      "campus": {
        "id": 1,
        "name": "Chatham Campus"
      },
      "applied_academic_year": "2025",
      "applied_grade": "2",
      "tags": [
        {
          "id": 84,
          "title": "EAL"
        }
      ],
      "agent": {
        "id": 1,
        "email": "[email protected]",
        "agency_name": "test"
      },
      "archived_at": null,
      "students": [
        {
          "id": null,
          "nationality": {
            "alpha2": "UM"
          },
          "name": "test",
          "last_name": "account",
          "gender": null,
          "birthday": null
        }
      ],
      "created_at": "2020-09-22T06:52:55.000Z",
      "updated_at": "2020-09-22T06:52:55.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "pages": 2,
    "per_page": 50
  }
}

Create a New Contact

post

https://api.openapply.comhttps://api.openapply.cn

/api/v3/contacts

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

first_namestringRequired

last_namestringRequired

phone_numberstringRequired

emailstringRequired

employer_companystringOptional

job_titlestringOptional

applied_academic_yearstringOptional

applied_gradestringOptional

campus_idintegerOptional

agent_idinteger[]Optional

tag_idsinteger[]Optional

source_campaign_idintegerOptional

Responses

200

successful

application/json

422

invalid source_campaign_id structure

application/json

post

/api/v3/contacts

HTTPcURLJavaScriptPython

POST /api/v3/contacts HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "first_name": "text",
  "last_name": "text",
  "phone_number": "text",
  "email": "text",
  "employer_company": "text",
  "job_title": "text",
  "applied_academic_year": "text",
  "applied_grade": "text",
  "campus_id": 1,
  "agent_id": [
    1
  ],
  "tag_ids": [
    1
  ],
  "students": [
    {
      "first_name": "text",
      "last_name": "text",
      "birthday": "text",
      "gender": "text",
      "nationality": "text"
    }
  ],
  "source_campaign_id": 1
}

{
  "contacts": {
    "id": 1,
    "first_name": "Roland",
    "last_name": "Bayer",
    "lead": "Sign up for Admissions Information",
    "email": "[email protected]",
    "avatar_url": "/assets/fallback/thumb_default_avatar-9af962b3cff94e1532ddd91a97e977b8461383e9f4e7e33dfd573942a9de5e45.png?v=1600757575",
    "representative": "",
    "add_by_school": false,
    "source_campaign": {
      "id": 8,
      "campaign": "Facebook - 2020 - 03",
      "source": "Facebook"
    },
    "contact_date": "2020-09-22",
    "converted": false,
    "mailing_list": [],
    "email_campaign": [],
    "phone_number": "",
    "employer_company": "",
    "job_title": "",
    "campus": {
      "id": 1,
      "name": "Chatham Campus"
    },
    "applied_academic_year": "2025",
    "applied_grade": "2",
    "tags": [
      {
        "id": 84,
        "title": "EAL"
      }
    ],
    "agent": {
      "id": 1,
      "email": "[email protected]",
      "agency_name": "test"
    },
    "archived_at": null,
    "students": [
      {
        "id": null,
        "nationality": {
          "alpha2": "UM"
        },
        "first_name": "test",
        "last_name": "account",
        "gender": null,
        "birthday": null
      }
    ],
    "created_at": "2020-09-22T06:52:55.000Z",
    "updated_at": "2020-09-22T06:52:55.000Z"
  }
}

Get a Contact

get

https://api.openapply.comhttps://api.openapply.cn

/api/v3/contacts/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Serial database ID that uniquely identifies a contact record in OpenApply

Responses

200

successful

application/json

get

/api/v3/contacts/{id}

HTTPcURLJavaScriptPython

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

200

successful

{
  "contacts": {
    "id": 1,
    "first_name": "Roland",
    "last_name": "Bayer",
    "lead": "Sign up for Admissions Information",
    "email": "[email protected]",
    "avatar_url": "/assets/fallback/thumb_default_avatar-9af962b3cff94e1532ddd91a97e977b8461383e9f4e7e33dfd573942a9de5e45.png?v=1600757575",
    "representative": "",
    "add_by_school": false,
    "source_campaign": {
      "id": 8,
      "campaign": "Facebook - 2020 - 03",
      "source": "Facebook"
    },
    "contact_date": "2020-09-22",
    "converted": false,
    "mailing_list": [],
    "email_campaign": [],
    "phone_number": "",
    "employer_company": "",
    "job_title": "",
    "campus": {
      "id": 1,
      "name": "Chatham Campus"
    },
    "applied_academic_year": "2025",
    "applied_grade": "2",
    "tags": [
      {
        "id": 84,
        "title": "EAL"
      }
    ],
    "agent": {
      "id": 1,
      "email": "[email protected]",
      "agency_name": "test"
    },
    "archived_at": null,
    "students": [
      {
        "id": null,
        "nationality": {
          "alpha2": "UM"
        },
        "first_name": "test",
        "last_name": "account",
        "gender": null,
        "birthday": null
      }
    ],
    "created_at": "2020-09-22T06:52:55.000Z",
    "updated_at": "2020-09-22T06:52:55.000Z"
  }
}

Update a Contact

put

https://api.openapply.comhttps://api.openapply.cn

/api/v3/contacts/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Serial database ID that uniquely identifies a contact record in OpenApply

Body

application/json

first_namestringOptional

last_namestringOptional

phone_numberstringOptional

emailstringOptional

employer_companystringOptional

job_titlestringOptional

applied_academic_yearstringOptional

applied_gradestringOptional

campus_idintegerOptional

agent_idinteger[]Optional

tag_idsinteger[]Optional

source_campaign_idintegerOptional

Responses

200

successful

application/json

404

not_found

application/json

put

/api/v3/contacts/{id}

HTTPcURLJavaScriptPython

PUT /api/v3/contacts/{id} HTTP/1.1
Host: api.openapply.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "first_name": "text",
  "last_name": "text",
  "phone_number": "text",
  "email": "text",
  "employer_company": "text",
  "job_title": "text",
  "applied_academic_year": "text",
  "applied_grade": "text",
  "campus_id": 1,
  "agent_id": [
    1
  ],
  "tag_ids": [
    1
  ],
  "students": [
    {
      "first_name": "text",
      "last_name": "text",
      "birthday": "text",
      "gender": "text",
      "nationality": "text"
    }
  ],
  "source_campaign_id": 1
}

{
  "contacts": {
    "id": 1,
    "first_name": "Roland",
    "last_name": "Bayer",
    "lead": "Sign up for Admissions Information",
    "email": "[email protected]",
    "avatar_url": "/assets/fallback/thumb_default_avatar-9af962b3cff94e1532ddd91a97e977b8461383e9f4e7e33dfd573942a9de5e45.png?v=1600757575",
    "representative": "",
    "add_by_school": false,
    "source_campaign": {
      "id": 8,
      "campaign": "Facebook - 2020 - 03",
      "source": "Facebook"
    },
    "contact_date": "2020-09-22",
    "converted": false,
    "mailing_list": [],
    "email_campaign": [],
    "phone_number": "",
    "employer_company": "",
    "job_title": "",
    "campus": {
      "id": 1,
      "name": "Chatham Campus"
    },
    "applied_academic_year": "2025",
    "applied_grade": "2",
    "tags": [
      {
        "id": 84,
        "title": "EAL"
      }
    ],
    "agent": {
      "id": 1,
      "email": "[email protected]",
      "agency_name": "test"
    },
    "archived_at": null,
    "students": [
      {
        "id": null,
        "nationality": {
          "alpha2": "UM"
        },
        "first_name": "test",
        "last_name": "account",
        "gender": null,
        "birthday": null
      }
    ],
    "created_at": "2020-09-22T06:52:55.000Z",
    "updated_at": "2020-09-22T06:52:55.000Z"
  }
}