Get users

get

https://sb-api.xpollens.com/api/v2.0/users

Description

This endpoint allows the partner to retrieve the physical persons.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

LastName

string

User's last name

Regex: ^[A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+(['’ -][A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+)*$

FirstName

string

User's first name

Regex: ^[A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+(['’ -][A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+)*$

BirthName

string

User's birth name

Regex: ^[A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+(['’ -][A-Za-zÆ-Ëæ-ëÎîÏïÔôÖöÙùÛûÜüŸÿŒœÀàÂâÄä]+)*$

string

User's email address
Format: valid email address (RFC 2821)

PhoneNumber

string

User's mobile phone number

Format: E.164

Example: "+33684756265"

AppUserId

string

length between 6 and 30

^[a-zA-Z0-9-_.!§)(]*$

User identifier from the Partner.

Format: min 6 characters, max 30 characters

Accepted characters: 0-9 a-z A-Z _ - . ! § ( )

Regex: ^[a-zA-Z0-9-_.!§)(]*$

DependenceId

string

Parent's identifier. It's mandatory if roles are not null.

Direction

string

Direction should be "Next", "Previous" or null

PageSize

int32

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

PageIndex

int64

Page Index is requested to request a certain page of result. It is given in every request you make to request the next or the previous page.

Headers

CorrId

string

Defaults to e82ba82f-02b8-495b-bbe7-33797ebb8316

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

400Bad Request

404Not Found