GET : Users by media

This endpoint lets you retrieve every users for a media.

This endpoint requires:

  • media_admin or brand_admin roles

  • r_users scope

Media users

GET https://api.piloty.fr/users

Query Parameters

Name
Type
Description

media-public-id*

String

Public id of the media

company-public-id

String

Public id of the company

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

page

Number

Page to retrieve (default=1)

limit

Number

Amount of items per page (default=500)

Response examples

Request

https://api-piloty.fr/users?media-public-id=[authorized_media]

Response

{
    "total": 121,
    "totalPages": 7,
    "next-page":"CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg==",
    "users": [
        {
            "company": {
                "public_id": "some-company",
                "name": "Some Company",
                "state": "published"
            },
            "firstname": "John",
            "lastname": "Doe",
            "email": "[email protected]",
            "picture": null,
            "phone_number": "+33000000000",
            "createdAt": "2025-02-13T15:49:32.047Z"
        },
        {...}
    ]
}
Request example
curl    -X GET -G "https://api-piloty.fr/users?media-public-id=acme_media \
        -H "Authorization: Bearer PILOTY_TOKEN"

Last updated