GET : User candidates by media

This endpoint lets you retrieve every user candidates for a media.

This endpoint requires:

• media_admin or brand_admin roles

• r_candidates scope

Media user candidates

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

Query Parameters

Name	Type	Description
media-public-id*	String	Public id of the media
email	String	Email of the user
created_after	ISO8601-Compatible Date	Show users created after this date
created_before	ISO8601-Compatible Date	Show users created before this date
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?media-public-id=[authorized_media]

Response

{
    "total": 121,
    "totalPages": 7,
    "next-page":"CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg==",
    "user_candidates": [
        {
            "firstname": "John",
            "lastname": "Doe",
            "email": "[e-mail]",
            "picture_url": "https://image.com/image1234.jpg",
            "resume_url": "https://image.com/image1234.jpg",
            "covering_letter": "<p>Lorem ipsum ....</p>",
            "links": [
                {
                    "ref": "linkedin",
                    "url": "https://www.linkedin.com/in/johndoe"
                }
            ],
            "phone_number": "0102030405",
            "anniversary": "1994-07-30T23:00:00Z",
            "opportunity_search": {
                "remote_ids": [],
                "location_ids": [
                    {
                        "id": "663367cdda3ff183f650eb35",
                        "name": "Versailles, 78000, Ile de France, France"
                    }
                ],
                "contract_ids": [
                    {
                        "id": "627d16c172f9aba0dccfb00d",
                        "name": "Apprenticeship"
                    }
                ],
                "job_category_ids": [
                    {
                        "id": "66ed37efaf7400f3d53d0080",
                        "parent_id": "6322ea3c2cca2e7e75fbfb44",
                        "ref": "maintenance_technician"
                    },
                    {
                        "id": "66ed37efaf7400f3d53d00cc",
                        "parent_id": "6322ea3c2cca2e7e75fbfb44",
                        "ref": "electrical_maintenance_technician"
                    },
                    {
                        "id": "66ed37f1af7400f3d53d026a",
                        "parent_id": "6322ea3c2cca2e7e75fbfb44",
                        "ref": "industrial_maintenance_technician"
                    }
                ],
                "experience_id": {
                    "id": "627d1a7c72f9aba0dcd081e6",
                    "name": "XP > 1 year"
                },
                "comment": "<p>Lorem ipsum ....</p>"
            },
            "onboardedAt": "2025-02-11T09:31:48.233Z",
            "createdAt": "2025-02-11T09:31:48.233Z"
        },
        {...}
    ]
}

401: Unauthorized unauthorized limitation

Request

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

Response

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

400: Bad request missing media-public-id

Request

https://api-piloty.fr/user_candidates

Response

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

Request example

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