Search by filter

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.

Link to swagger

This endpoint is synchronous

The role user is needed in order to use this endpoint

Endpoints

---

GET/v1/directory/fr/search

---

Query parameters

---

qRequired string - RequiredRefer to page filter

offsetinteger - Optional - Default value : 0

The number of records to skip before starting to return results. This is used to specify the starting point of the results to be fetched.

---

limitinteger - Optional - Default value : 50

The maximum number of records to return.

---

Request

---

GET /v1/directory/fr/search

bash

  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}'

javascript

    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);
        }
    })();

.NET

    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

---

200 OK

  [{
    "source": "French Directory",
    "directoryId": "591843c4-f0d0-48f5-ad6b-39b2af17a4e5",
    "country": "FR",
    "name": "IOPOLE",
    "electronicAddress": null,
    "entity": {
      "siren": "922304308",
      "siret": "92230430800013",
      "routingCode": null,
      "routingCodeType": null,
      "entityType": "Assujetti",
      "status": "ACTIVE"
    }
  }]