Skip to main content
POST
/
users
/
search
Query users
curl --request POST \
  --url https://us.api.flexprice.io/v1/users/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_time": "2023-11-07T05:31:56Z",
  "expand": "<string>",
  "filters": [
    {
      "field": "<string>",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "limit": 500,
  "offset": 1,
  "roles": [
    "<string>"
  ],
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "start_time": "2023-11-07T05:31:56Z",
  "user_ids": [
    "<string>"
  ]
}
'
{
  "items": [
    {
      "email": "<string>",
      "id": "<string>",
      "roles": [
        "<string>"
      ],
      "tenant": {
        "billing_details": {
          "address": {
            "address_city": "<string>",
            "address_country": "<string>",
            "address_line1": "<string>",
            "address_line2": "<string>",
            "address_postal_code": "<string>",
            "address_state": "<string>"
          },
          "email": "<string>",
          "help_email": "<string>",
          "phone": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "status": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

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

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

​
end_time
string<date-time>
​
expand
string
​
filters
object[]

filters allows complex filtering based on multiple fields

​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
roles
string[]
​
sort
object[]
​
start_time
string<date-time>
​
status
enum<string>
Available options:
published,
deleted,
archived
​
type
enum<string>
Available options:
user,
service_account
​
user_ids
string[]

Specific filters for users

Response

OK

​
items
object[]
​
pagination
object