Agents

This page describes all the APIs relating to agents

Get all Agents

get

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

/api/v3/agents

Retrieves a list of all agents. Results are paginated. Use the page and per_page query parameters to control pagination.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

since_datestring · date_timeOptional

Return results updated since the specified date, in UTC timezone

Example: 2025-01-01T00:00:00Z

since_idintegerOptional

Return results with an ID greater than the specified ID.

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

agents found

application/json

get

/api/v3/agents

HTTPcURLJavaScriptPython

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

200

agents found

{
  "agents": [
    {
      "id": 1,
      "email": "[email protected]",
      "first_name": null,
      "last_name": null,
      "gender": null,
      "updated_at": "2025-02-17T00:00:00.000Z",
      "agency_name": "test",
      "profile_photo": null,
      "custom_fields": {},
      "student_ids": []
    },
    {
      "id": 2,
      "email": "[email protected]",
      "first_name": null,
      "last_name": null,
      "gender": null,
      "updated_at": "2025-02-17T00:00:00.000Z",
      "agency_name": "testttt",
      "profile_photo": null,
      "custom_fields": {},
      "student_ids": []
    }
  ],
  "meta": {
    "pages": 1,
    "page": 1,
    "per_page": 50
  }
}

Get an Agent

get

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

/api/v3/agents/{id}

Fetch an instance of a agent

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Serial database ID used to refer to a unique student record in OpenApply

Responses

200

agent found

application/json

get

/api/v3/agents/{id}

HTTPcURLJavaScriptPython

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

200

agent found

{
  "agents": {
    "id": 1,
    "email": "[email protected]",
    "first_name": null,
    "last_name": null,
    "gender": null,
    "updated_at": "2025-02-17T00:00:00.000Z",
    "agency_name": "test",
    "profile_photo": null,
    "custom_fields": {},
    "student_ids": []
  }
}