Get a list of contacts

get

https://api.remberg.de/v1/contacts

Returns a paginated list of contacts. Supports filtering by organization number, creation and update timestamps, and free-text search, as well as sorting and pagination via query parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

organizationNumber

string

Specify the organization number the contacts belong to.

sortDirection

string

enum

Define the sort order of the received payload. (asc/desc)

Allowed:

sortField

string

enum

Specify the field used for sorting.

Allowed:

page

number

Page number.

limit

number

Define how many items will be received in the payload per request.(default 20 items, max 1000 items)

string

Allows to filter by the search phrase over fullName, email properties.

createdAtFrom

date-time

Filter by createdAt date FROM the provided value as an ISO UTC string. Inclusive.

createdAtUntil

date-time

Filter by createdAt date UNTIL the provided value as an ISO UTC string. Inclusive.

updatedAtFrom

date-time

Filter by updatedAt date FROM the provided value as an ISO UTC string. Inclusive.

updatedAtUntil

date-time

Filter by updatedAt date UNTIL the provided value as an ISO UTC string. Inclusive.

Headers

remberg-active-site-ref

string

^s[1-9]\d*$

The site the request acts on, e.g. s2. You find it in the remberg web app URL (e.g. /s2/) or next to the site name under Settings → Sites. If your account has access to more than one site, send this header on every request; site-specific requests without it fail with 403 ACTIVE_SITE_UNAVAILABLE. With access to a single site, that site is used when the header is omitted. A site your account cannot access fails with 403 ACTIVE_SITE_UNAVAILABLE; a record that belongs to another site returns 404.

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Header

Loading…

Response

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

application/json

200List of Contact objects