GET : Favoris

This endpoint lets you retrieve every Favoris for a media.

This endpoint requires:

• media_admin or brand_admin roles

• r_candidates scope

List Job alerts

GET https://api.piloty.fr/user_candidates/favorites

Query Parameters

Name	Type	Description
media-public-id*	String	Public id of the media
user_candidate_id	string	filter for on User Candidate
limit	Number	Amount of items per page (default=500)
next-page	String	Cursor to definition. See Pagination

Response examples

200: OK success

Request

https://api-piloty.fr/user_candidates/favorites?limit=10&media-public-id=[authorized_media]

Response

{
    "total": 121,
    "totalPages": 4,
    "next-page":"CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg==",
    "data": [
        {
            "user_candidate_id": "67c03952928e0a0aaef34533",
            "companies": [
                {
                    "id": "67c03952928e0a0aaef34533",
                    "name": "Acme company",
                    "public_id":"acme-company"
                }, 
                [...]
            ],
            "jobs": [
                {
                    "id": "67c03952928e0a0aaef34533",
                    "name": "Aide-soignant de NUIT",
                    "public_id":"aide-soignant-de-nuit",
                    "company_id": "661647be46eaeb810bbd6f33",
                    "company_name": "Acme company",
                    "company_public_id": "acme-company"
                },
                [...]
            ]
        }
        [....]
    ]
}

401: Unauthorized unauthorized limitation

Request

https://api-piloty.fr/favorites?media-public-id=[unauthorized_media]

Response

{
    "status": 401,
    "error": "unauthorized-limitation"
}

400: Bad request missing media-public-id

Request

https://api-piloty.fr/favorites

Response

{
    "status": 400,
    "error": "missing-media-public-id"
}

Request example

curl    -X GET -G "https://api-piloty.fr/favoris?media-public-id=acme_media \
        -H "Authorization: Bearer PILOTY_TOKEN"