{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/applicants/:id/transitions","auth":"required","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"transitions\": [\n        {\n            \"stage_id\": \"1616be95-0e4a-3f16-8e85-03e061345c07\",\n            \"stage_title\": \"Screening\",\n            \"created_at\": \"2021-06-14T23:44:56.053-07:00\",\n            \"parent_stage_id\": null,\n            \"parent_stage_title\": null,\n            \"sub_stage_id\": null,\n            \"sub_stage_title\": null\n        },\n        {\n            \"stage_id\": \"f6e4448c-2fac-4962-8c31-638aba1e4374\",\n            \"stage_title\": \"Background Check\",\n            \"created_at\": \"2021-06-14T23:44:59.640-07:00\",\n            \"parent_stage_id\": null,\n            \"parent_stage_title\": null,\n            \"sub_stage_id\": null,\n            \"sub_stage_title\": null\n        }\n    ],\n    \"pagination\": {\n        \"first\": 1,\n        \"previous\": null,\n        \"current\": 1,\n        \"next\": null,\n        \"last\": 1,\n        \"current_cursor\": \"R0hwZHR2VDlLbmdoUmFwdTRwZmRoZ0JXA5Vis1UzBXZXJZdz0tLTVXVGVPSnlIMWxQN0g0bG53V0Y2N3c9PQ==--f1dd0364c1b4d720009b494ff1c7a39126212b87\",\n        \"next_cursor\": \"ei9TRWpDZlJDWVZOTENUUGp0Z0p1RWM3NGhvYXFZNUMrZHExND0tLVh3TjlMWVFDNmIyd1hsUlBwd0x4b3c9PQ==--b2d9d156921d69c09ab56c5285afcb08c9855158\"\n    }\n}"},{"language":"json","code":"{\n  \"message\": \"Authentication is required\"\n}","name":"","status":401}]},"method":"get","examples":{"codes":[{"code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' 'https://api.fountain.com/v2/applicants/550e8400-e29b-41d4-a716-446655440000/transitions?page=2'","language":"curl"}]},"settings":"","params":[{"name":"id","type":"string","default":"550e8400-e29b-41d4-a716-446655440000","desc":"ID must be included in the URL","required":true,"in":"path","ref":"","_id":"5b3c0964e41dc40003f7572e"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60db93f764696300442dcab8"},{"name":"page","type":"int","default":"1","desc":"Page number for cursor-based pagination","required":false,"in":"query","ref":"","_id":"61df1dfca4bc190040525652"}]},"next":{"description":"","pages":[]},"title":"Get Transition History","type":"endpoint","slug":"get-transition-history","excerpt":"","body":"This method returns the transition history of an applicant.\n\nCursor pagination is available, each page will return up to 100 stage transitions.","updates":["60c2472bf395d50150c1fde3"],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6919","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Applicant Management","slug":"endpoints","order":2,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68fa","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"createdAt":"2016-02-19T01:01:16.044Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"project":"59de6011debd1200240f68ec","__v":20,"user":"547504ed59fade080004cb8b","createdAt":"2017-03-02T00:07:55.359Z","githubsync":""}

getGet Transition History


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string550e8400-e29b-41d4-a716-446655440000
ID must be included in the URL

Query Params

page:
integer1
Page number for cursor-based pagination

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token

Examples


Result Format


Documentation

This method returns the transition history of an applicant. Cursor pagination is available, each page will return up to 100 stage transitions.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}