Skip to main content
POST
/
organizations
/
filter
Filter organizations
curl --request POST \
  --url https://prod-api.pcxpay.com/v1/organizations/filter \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "country": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "limit": 10,
  "last_evaluated_key": {}
}
'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "organizations": [
      {}
    ],
    "lastEvaluatedKey": {},
    "count": 123,
    "scanned_count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Body

application/json
​
country
string
​
start_date
string

ISO 8601 datetime (e.g. 2025-01-01T00:00:00.000Z)

​
end_date
string

ISO 8601 datetime (e.g. 2025-12-31T23:59:59.999Z)

​
limit
integer
default:10
​
last_evaluated_key
object

DynamoDB pagination cursor from previous response

Response

200 - application/json

Filtered organizations

​
status
string
​
message
string
​
data
object