API Reference
GuidesAPI ReferenceRoadmapGo to DashboardSite >

List Entities

get
https://api.stage.localpayment.com/api/entity/v1/entities

Returns a paginated list of your entities.

Query Params
string
enum

INDIVIDUAL or COMPANY.

Allowed:
string
enum

Entity status.

Allowed:
string

Exact match on your identifier.

string

Document number of any declared document (exact match).

string
enum

NO_FILES, PARTIAL, COMPLETE.

Allowed:
date-time

ISO 8601, inclusive.

date-time

ISO 8601, inclusive.

boolean

Include CLOSED entities. Default false.

integer

Zero-based page. Default 0.

integer

Default 20, maximum 200 (larger values are capped).

Headers
string

Trace identifier (UUID). Echoed in the response; generated by Localpayment if absent.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 days ago

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

Updated 11 days ago

Did this page help you?