Skip to main content
GET
/
v1
/
companies
Search for Companies
curl --request GET \
  --url https://external.pleo.io/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "address": {
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "country": "<string>",
        "locality": "<string>",
        "postalCode": "<string>",
        "region": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "registrationNumber": "<string>"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": []
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Query Parameters

​
organization_id
string<uuid>

Enter the organization ID of the companies you are searching for. Ensure that the access token used for authentication has the correct permissions to search for companies in the given organization.

​
before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

Pattern: ^[A-Z2-7=~]+$
​
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

Pattern: ^[A-Z2-7=~]+$
​
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

​
limit
integer<int32>

The maximum amount of items to return.

​
sorting_keys
string[]

The keys to sort the results by.

​
sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Response

Company search successful

​
data
object[]
required
​
pagination
object
required