Home
API Reference

/api/v4.0/business-entities

get
https://sb-api.xpollens.com/api/v4.0/business-entities
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 6 and 30
^[a-zA-Z0-9-_.!§)(]*$

Description

Filter on the businessEntity identifier

Rules / Possible values

  • Min 6 / max 30 chars
  • Accepted characters: 0-9 a-z A-Z _ - . ! § ( )
  • Regex: ^[a-zA-Z0-9-_.!§)(]*$
string
enum

Description

Filter on the relation status

Rules / Possible values

  • Initialized
  • InProgress
  • Active
  • AwaitingInactivation
  • Inactive
Allowed:
string

Description

Filter on the company name

Rules / Possible values

  • Optional filter on the company name
string

Description

Filter on the registration number

Rules / Possible values

  • Optional filter on the registration number (SIRET/SIREN for France)
int32

Number of element per page lesser than or equals to 200 (default: 50)

int32

Cursor to retrieve previous page — mutually exclusive with after

int32

Cursor to retrieve next page — mutually exclusive with before

Headers
string
Defaults to e729920f-6142-4e01-8996-3a81d05bc47c

Correlation Id

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 1 month ago

Did this page help you?