GET : Companies by media

This endpoint lets you retrieve all companies for a given media.

This endpoint requires :

• brand_admin, media_admin or media_partner roles.

• r_companies scope.

Media companies list

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

Important fields

• public_id : Unique identifier of the company

• is_published : Is the Company is published throughout the media

Query Parameters

Name	Type	Description
media-public-id*	String	Public id of the media
search	String	Search by company name

200: OK success

[
    "total": 121,
    "totalPages": 13,
    "next-page":"CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg==",
    "data":[
        {
            "id": "6295debf398f8985f09dc99d",
            "name": "Trusty",
            "public_id": "trusty",
            "size": "62cc627cf40fc5d45819d8f8",
            "sectors": [
                "630f96baa4ef90ff2a51ee34"
            ],
            "content": {
                "visual": {
                    "logo": "https://piloty-public-staging.s3.amazonaws.com/companiesDocuments/6295debf398f8985f09dc99d/6295debf398f8985f09dc99d_logo_1710944607812"
                },
                "description":"Lorem Ipsum ...",
                "language": "fr"
            },
            "is_published": true,
            "is_vme_page_published" : false
        },
        {
            "id": "65a945ae4ba3076d0096cd8e",
            "name": "Tesla",
            "public_id": "tesla",
            "size": null,
            "sectors": [
                "615ef4b4d8764832b8bc55dc"
            ],
            "content": {
                "visual": {
                    "logo": "https://piloty-public-staging.s3.amazonaws.com/companiesDocuments/65a945ae4ba3076d0096cd8e/65a945ae4ba3076d0096cd8e_logo_1705596907642"
                },
                "language": "fr"
            },
            "is_published": true,
            "is_vme_page_published" : false
        },
        {...},
    ]
]

401: Unauthorized unauthorized-limitation

{
    "statusCode": 401,
    "error": "unauthorized-limitation",
    "errorMessage": "Unauthorized"
}

400: Bad Request missing-media-public-id

{
    "statusCode": 400,
    "error": "missing-media-public-id",
    "errorMessage": "Bad Request"
}

Request example

curl -X GET -G "https://api-piloty.fr/companies" \
    -H "Authorization: Bearer PILOTY_TOKEN" \
    -d "media-public-id=acme-media"