{ "opencollection": "1.0.0", "info": { "name": "Get on Board Applications Processes API", "version": "0.1.0" }, "items": [ { "info": { "name": "Processes", "type": "folder" }, "items": [ { "info": { "name": "List processes", "type": "http" }, "http": { "method": "GET", "url": "https://www.getonbrd.com/api/v0/processes", "headers": [ { "name": "Authorization", "value": "Bearer YOUR_API_KEY" } ], "params": [ { "name": "page", "value": "2", "type": "query", "description": "Page number, starting at 1." }, { "name": "per_page", "value": "2", "type": "query", "description": "Number of records per page. The default and maximum are usually 120 unless an endpoint documents a different behavior." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List processes" }, { "info": { "name": "Retrieve a process", "type": "http" }, "http": { "method": "GET", "url": "https://www.getonbrd.com/api/v0/processes/:id", "headers": [ { "name": "Authorization", "value": "Bearer YOUR_API_KEY" } ], "params": [ { "name": "expand", "value": "job,phases", "type": "query" }, { "name": "id", "value": "1", "type": "path", "description": "Hiring process ID from `GET /api/v0/processes`." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a process" }, { "info": { "name": "List process phases", "type": "http" }, "http": { "method": "GET", "url": "https://www.getonbrd.com/api/v0/processes/:process_id/phases", "headers": [ { "name": "Authorization", "value": "Bearer YOUR_API_KEY" } ], "params": [ { "name": "process_id", "value": "5", "type": "path", "description": "Hiring process ID from `GET /api/v0/processes` or `GET /api/v0/jobs/{job_id}/processes`." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Use each returned phase `id` as `phase_id` in `PATCH /api/v0/applications/{application_id}/phase`. If the chosen phase has `kind: \"discarded\"`, also send a valid `discard_reason`." } ] } ], "bundled": true }