> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/openapply/public-rest-apis/v3/contacts.md).

# Contacts

This page describes all the APIs relating to contacts.

## GET /api/v3/contacts

> Get all Contacts

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Contacts","description":"This page describes all the APIs relating to contacts."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/contacts":{"get":{"summary":"Get all Contacts","tags":["Contacts"],"operationId":"listContacts","parameters":[{"name":"page","in":"query","required":false,"description":"The page number of results to return.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"description":"Request for how many records to return.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"count","in":"query","required":false,"description":"Synonym for per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{}}}}}}}}
```

## POST /api/v3/contacts

> Create a New Contact

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Contacts","description":"This page describes all the APIs relating to contacts."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/contacts":{"post":{"summary":"Create a New Contact","tags":["Contacts"],"operationId":"createContact","parameters":[],"responses":{"200":{"description":"successful","content":{"application/json":{}}},"422":{"description":"invalid source_campaign_id structure","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"employer_company":{"type":"string"},"job_title":{"type":"string"},"applied_academic_year":{"type":"string"},"applied_grade":{"type":"string"},"campus_id":{"type":"integer"},"agent_id":{"type":"array","items":{"type":"integer"}},"tag_ids":{"type":"array","items":{"type":"integer"}},"students":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"birthday":{"type":"string"},"gender":{"type":"string"},"nationality":{"type":"string"}}}},"source_campaign_id":{"type":"integer"}},"required":["first_name","last_name","phone_number","email"]}}}}}}}}
```

## GET /api/v3/contacts/{id}

> Get a Contact

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Contacts","description":"This page describes all the APIs relating to contacts."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/contacts/{id}":{"get":{"summary":"Get a Contact","tags":["Contacts"],"operationId":"getContact","parameters":[{"name":"id","in":"path","description":"Serial database ID that uniquely identifies a contact record in OpenApply","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{}}}}}}}}
```

## PUT /api/v3/contacts/{id}

> Update a Contact

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Contacts","description":"This page describes all the APIs relating to contacts."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/contacts/{id}":{"put":{"summary":"Update a Contact","tags":["Contacts"],"operationId":"updateContact","parameters":[{"name":"id","in":"path","description":"Serial database ID that uniquely identifies a contact record in OpenApply","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{}}},"404":{"description":"not_found","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"email":{"type":"string"},"employer_company":{"type":"string"},"job_title":{"type":"string"},"applied_academic_year":{"type":"string"},"applied_grade":{"type":"string"},"campus_id":{"type":"integer"},"agent_id":{"type":"array","items":{"type":"integer"}},"tag_ids":{"type":"array","items":{"type":"integer"}},"students":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"birthday":{"type":"string"},"gender":{"type":"string"},"nationality":{"type":"string"}}}},"source_campaign_id":{"type":"integer"}}}}}}}}}}
```