1. Users
ImmigraFlow API
  • Check
    • Check case status
      POST
  • Users
    • Verify email token
      POST
    • List users
      GET
    • Create user
      POST
    • Get user
      GET
    • Update user
      PUT
  • Cases
    • List user cases
      GET
    • Create case
      POST
    • Get one case
      GET
    • Update case
      PUT
  • Webhooks
    • List webhooks
      GET
    • Create webhook
      POST
    • Get webhook
      GET
    • Update webhook
      PUT
    • Delete webhook
      DELETE
  • Schemas
    • ErrorEnvelope
    • CheckRequest
    • User
    • UserCreateRequest
    • UserUpdateRequest
    • CaseSummary
    • CaseCreateRequest
    • CaseUpdateRequest
    • StatusUpdate
    • CaseDetailsResponse
    • CheckResponse
    • Webhook
    • WebhookCreateRequest
    • WebhookUpdateRequest
  1. Users

List users

GET
/v1/users
Returns all users belonging to the authenticated partner.

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
API Key
Add parameter in header
X-API-SECRET
Example:
X-API-SECRET: ********************
or

Responses

🟢200
application/json
Users list
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://devapi.immigraflow.com/v1/users' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>'
Response Response Example
200 - Example 1
{
    "users": [
        {
            "id": 0,
            "email": "user@example.com",
            "name": "string",
            "phone": "string",
            "notify_by_email": true,
            "notify_by_whatsapp": true,
            "status": "active",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z"
        }
    ]
}
Modified at 2026-04-20 08:31:25
Previous
Verify email token
Next
Create user
Built with