Version: Next

Search in French directory

Information

This API allow you to search for a company into the legal FR directory only.

The response provided by the API is an array that includes all the directory entries matching the search criteria provided by the user.

This endpoint is synchronous

The role user is needed in order to use this endpoint

Endpoints

GET/v1/directory/french

Query parameters

qstring - RequiredRefer to page filter

Search query

offsetnumber (int) - Optional

The "offset" parameter specifies the initial position in the result set from which the API should start retrieving data. It works together with the "limit" parameter to enable pagination. For instance, when the offset is set to 500 and the limit is set to 100, the API will skip the first 500 rows and provide the next 100 rows.

limitnumber (int) - Optional

The "limit" parameter defines the maximum number of rows to be included in the response.

Request

GET /v1/directory/fr/search

bash
javascript
.NET

  curl -X 'GET'
  'https://api.ppd.iopole.fr//v1/directory/fr/search?q=name%3A%2A&limit=50'
  -H 'accept: application/json'
  -H 'Authorization: Bearer ${token}'

    const got = require('got');
    const token = 'your_token_here';
    const limit = 50;
    
    (async () => {
    try {
        const response = await got(`https://api.ppd.iopole.fr//v1/directory/fr/search?q=name:*&limit=${limit}`, {
            headers: {
                'accept': 'application/json',
                'Authorization': `Bearer ${token}`,
            },
            responseType: 'json',
        });
    
        console.log(response.body);
        } catch (error) {
            console.error(error.response.body);
        }
    })();

    using System;
    using System.Net.Http;
    using System.Threading.Tasks;
    class Program
    {
        static async Task Main(string[] args)
        {
            var token = "your_token_here";
            var limit = 50;
    
            using var client = new HttpClient();
            client.DefaultRequestHeaders.Add("accept", "application/json");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer ${token}");
    
            try
            {
                var response = await client.GetAsync("https://api.ppd.iopole.fr//v1/directory/fr/search?q=name:*&limit={limit}");
                response.EnsureSuccessStatusCode();
    
                var responseString = await response.Content.ReadAsStringAsync();
                Console.WriteLine(responseString);
            }
            catch (HttpRequestException ex)
            {
                Console.WriteLine("Request error: {ex.Message}");
            }
        }
    }

Response

Status: 200 - application/json

Description: Returns a list of directory entries that match the given criteria.

Schema:

Examples:

{
  "data": [
    {
      "businessEntityId": "0193acea-5c97-7665-ada2-c57495af205c",
      "name": "Legal unit Example 1",
      "type": "LEGAL_UNIT",
      "scope": "PRIVATE_TAX_PAYER",
      "siren": "007350101",
      "identifiers": [
        {
          "businessEntityIdentifierId": "0193acea-5c97-7665-ada2-cbe599f72cba",
          "type": "LEGAL_IDENTIFIER",
          "scheme": "0002",
          "value": "007350101",
          "networkRegistered": [
            {
              "directoryId": "0193c00e-1d01-7136-a979-7c3910409ee6",
              "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
              "networkIdentifier": "DOMESTIC_FR"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 1,
    "count": 1
  }
}
{
  "data": [
    {
      "businessEntityId": "0193acea-5d3b-7665-ada5-8441740e0b68",
      "name": "Head Office 1",
      "type": "OFFICE",
      "scope": "PRIMARY",
      "siren": "007350101",
      "siret": "00735010100015",
      "postalAddress": {
        "city": "city_1",
        "postalCode": "34000",
        "addressLine1": "addr1_1",
        "addressLine2": "addr2_1"
      },
      "legalUnit": {
        "businessEntityId": "0193acea-5d3a-7665-ada5-64ffee5ab779",
        "name": "Legal unit Example 1",
        "siren": "007350101"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "0193acea-5d3b-7665-ada5-8d5120d8e70b",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0009",
          "value": "00735010100015",
          "networkRegistered": [
            {
              "directoryId": "0123c00e-1d01-7136-a979-7c3910409ee6",
              "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
              "networkIdentifier": "DOMESTIC_FR"
            }
          ]
        }
      ],
      "meta": {
        "offset": 0,
        "limit": 1,
        "count": 1
      }
    }
  ]
}
{
  "data": [
    {
      "businessEntityId": "0193acea-5d3b-7665-ada5-8441740e0b68",
      "name": "Office 2",
      "type": "OFFICE",
      "scope": "SECONDARY",
      "siren": "007350101",
      "siret": "00735010100025",
      "postalAddress": {
        "city": "city_1",
        "postalCode": "34000",
        "addressLine1": "addr1_1",
        "addressLine2": "addr2_1"
      },
      "legalUnit": {
        "businessEntityId": "0193acea-5d3a-7665-ada5-64ffee5ab779",
        "name": "Legal unit Example 1",
        "siren": "007350101"
      },
      "identifiers": [
        {
          "businessEntityIdentifierId": "0777acea-5d3b-7665-ada5-8d5120d8e70b",
          "type": "OFFICE_IDENTIFIER",
          "scheme": "0009",
          "value": "00735010100025",
          "networkRegistered": [
            {
              "directoryId": "0178c00e-1d01-7136-a979-7c3910409ee6",
              "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
              "networkIdentifier": "DOMESTIC_FR"
            }
          ]
        },
        {
          "businessEntityIdentifierId": "0888acea-5d3b-7665-ada5-8d5120d8e70b",
          "type": "ROUTING_CODE",
          "scheme": "0224",
          "value": "Service A",
          "networkRegistered": [
            {
              "directoryId": "0199c00e-1d01-7136-a979-7c3910409ee6",
              "networkId": "b00d52d5-40b8-4d71-83f1-1709cf47e812",
              "networkIdentifier": "DOMESTIC_FR"
            }
          ]
        }
      ],
      "meta": {
        "offset": 0,
        "limit": 1,
        "count": 1
      }
    }
  ]
}

Status: 401

Description: Unauthorized - Authentication is required and has failed or has not yet been provided.

Status: 403

Description: Forbidden - The server understood the request, but it refuses to authorize it. Note: This endpoint requires an admin account.