Piloty API
  • Introduction
  • 🔓Authentication
  • 🔭Scopes and Roles
  • ⏲️Rate limits
  • 📂Pagination
  • ⁉️Errors and Status
  • 🏢COMPANIES API
    • Companies
      • GET : Companies by media
      • GET : Retrieve Company
      • POST : Create company
      • PATCH : Update company
    • Company 's fields
      • GET : List Sectors
      • GET : List Sizes
  • 💼JOBS API
    • Jobs
      • GET : Jobs by media
      • GET : Retrieve job
      • GET : Jobs opened by media
      • GET : Retrieve job opened
      • POST : Create job
      • PATCH : Update job
    • Job's fields
      • GET : List Contracts
      • GET : List Experiences
      • GET : List Educations
      • GET : List Remote policies
      • GET : List Worktimes
      • GET : List Job Categories
  • 👤USERS API
    • Users
      • GET : Users by media
  • 🧑‍💼CANDIDATES API
    • Candidates
      • GET : User candidates by media
      • GET : Job alerts
      • GET : Favoris
    • Opportunities
      • POST : Job applications - v2
      • GET : Job applications
      • 🛑Deprecated - POST : Job applications - v1
  • 📕Changelog
Powered by GitBook
On this page
  1. COMPANIES API
  2. Companies

GET : Retrieve Company

This endpoint lets you retrieve one company for a given public Id.

This endpoint requires :

• brand_admin, media_admin or media_partner roles.

• r_companies scope.

Company info

GET https://api-piloty.fr/companies/:company-public-id

Important fields

• public_id : Unique identifier of the company

• is_published : Is the company is published throughout the media

Path Parameters

Name
Type
Description

company-public-id*

String

Public id of the job

[
    "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
        }
]
{
    "status": 401,
    "error": "unauthorized-limitation",
    "errorMessage": "Unauthorized"
}
{
    "status": 404,
    "error": "company-not-found",
    "errorMessage": "Not found"
}

Request example

curl -X GET -G "https://api-piloty.fr/jobs/opened/:job-public-id" \
    -H "Authorization: Bearer PILOTY_TOKEN" \
PreviousGET : Companies by mediaNextPOST : Create company

Last updated 1 month ago

🏢